simscale_sdk.models package¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
Submodules¶
simscale_sdk.models.absolute_convergence_criteria module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.absolute_convergence_criteria.AbsoluteConvergenceCriteria(type='ABSOLUTE', tolerance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'tolerance': 'tolerance', 'type': 'type'}¶
- openapi_types = {'tolerance': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property tolerance¶
Gets the tolerance of this AbsoluteConvergenceCriteria. # noqa: E501
<p>Set the threshold value for convergence detection for the relative convergence criteria. If the maximum relative error of all DOFs fall below this value the current time step is considered convergent.</p></p> <br /><br />Important remarks: <br /><ul><li>In most of the cases using a lower value for tolerance may lead to hard or no convergence. Therefore, it is always recommended to start with a higher value e.g. 10<sup>-3</sup> or 10<sup>-4</sup>. Please also note that increasing the threshold value may effect the solution results. </li></ul> # noqa: E501
- Returns
The tolerance of this AbsoluteConvergenceCriteria. # noqa: E501
- Return type
float
- property type¶
Gets the type of this AbsoluteConvergenceCriteria. # noqa: E501
<p>Select the type of convergence criterion for the nonlinear solution method.</p> <br /><br />Important remarks: <br /><ul><li>Choose <b>absolute</b> if you want convergence to be reached when the maximum residual of all degrees of freedom of a given Newton iteration is lower than the given tolerance.</li><li>Choose <b>relative</b> if the same criteria as <b>absolute</b> will be checked but for the maximum relative residual i.e. maximum absolute residual divided by external force. Please note, if no external force is involved e.g. two far objects coming in contact, then using relative criteria will lead to singularity and convergence will not be attained.</li></ul> Schema name: AbsoluteConvergenceCriteria # noqa: E501
- Returns
The type of this AbsoluteConvergenceCriteria. # noqa: E501
- Return type
str
simscale_sdk.models.absolute_passive_scalar_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.absolute_passive_scalar_source.AbsolutePassiveScalarSource(type='ABSOLUTE', name=None, passive_scalar_variable=None, flux=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flux': 'flux', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'passive_scalar_variable': 'passiveScalarVariable', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property flux¶
Gets the flux of this AbsolutePassiveScalarSource. # noqa: E501
- Returns
The flux of this AbsolutePassiveScalarSource. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this AbsolutePassiveScalarSource. # noqa: E501
- Returns
The geometry_primitive_uuids of this AbsolutePassiveScalarSource. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this AbsolutePassiveScalarSource. # noqa: E501
- Returns
The name of this AbsolutePassiveScalarSource. # noqa: E501
- Return type
str
- openapi_types = {'flux': 'DimensionalPassiveScalarSourceRate', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'passive_scalar_variable': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property passive_scalar_variable¶
Gets the passive_scalar_variable of this AbsolutePassiveScalarSource. # noqa: E501
- Returns
The passive_scalar_variable of this AbsolutePassiveScalarSource. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AbsolutePassiveScalarSource. # noqa: E501
- Returns
The topological_reference of this AbsolutePassiveScalarSource. # noqa: E501
- Return type
- property type¶
Gets the type of this AbsolutePassiveScalarSource. # noqa: E501
Schema name: AbsolutePassiveScalarSource # noqa: E501
- Returns
The type of this AbsolutePassiveScalarSource. # noqa: E501
- Return type
str
simscale_sdk.models.absolute_power_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.absolute_power_source.AbsolutePowerSource(type='ABSOLUTE_V23', name=None, heat_flux=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'heat_flux': 'heatFlux', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this AbsolutePowerSource. # noqa: E501
- Returns
The geometry_primitive_uuids of this AbsolutePowerSource. # noqa: E501
- Return type
list[str]
- property heat_flux¶
Gets the heat_flux of this AbsolutePowerSource. # noqa: E501
- Returns
The heat_flux of this AbsolutePowerSource. # noqa: E501
- Return type
- property name¶
Gets the name of this AbsolutePowerSource. # noqa: E501
- Returns
The name of this AbsolutePowerSource. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'heat_flux': 'DimensionalFunctionPower', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AbsolutePowerSource. # noqa: E501
- Returns
The topological_reference of this AbsolutePowerSource. # noqa: E501
- Return type
- property type¶
Gets the type of this AbsolutePowerSource. # noqa: E501
<i>Power sources</i> can be used to simulate heat generation from a volume. Two types are available:<br><li><b>Absolute</b></li>: Used when total power emitted by the assigned volume is known.<li><b>Specific</b></li>: Used when power density of the assigned volume is known. <a href=’https://www.simscale.com/docs/simulation-setup/advanced-concepts/power-sources/’ target=’_blank’>Learn more</a>. Schema name: AbsolutePowerSource # noqa: E501
- Returns
The type of this AbsolutePowerSource. # noqa: E501
- Return type
str
simscale_sdk.models.acceleration_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.acceleration_field_selection.AccelerationFieldSelection(type='ACCELERATION', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this AccelerationFieldSelection. # noqa: E501
- Returns
The component_selection of this AccelerationFieldSelection. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AccelerationFieldSelection. # noqa: E501
Schema name: AccelerationFieldSelection # noqa: E501
- Returns
The type of this AccelerationFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.acceleration_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.acceleration_result_control_item.AccelerationResultControlItem(type='ACCELERATION', name=None, acceleration_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property acceleration_type¶
Gets the acceleration_type of this AccelerationResultControlItem. # noqa: E501
- Returns
The acceleration_type of this AccelerationResultControlItem. # noqa: E501
- Return type
- attribute_map = {'acceleration_type': 'accelerationType', 'name': 'name', 'type': 'type'}¶
- property name¶
Gets the name of this AccelerationResultControlItem. # noqa: E501
- Returns
The name of this AccelerationResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'acceleration_type': 'GlobalAccelerationType', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AccelerationResultControlItem. # noqa: E501
Schema name: AccelerationResultControlItem # noqa: E501
- Returns
The type of this AccelerationResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.active_adjustable_timestep module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.active_adjustable_timestep.ActiveAdjustableTimestep(type='ACTIVE_TIMESTEP', maximal_courant_number=None, maximal_step=None, max_alpha_co=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_alpha_co': 'maxAlphaCo', 'maximal_courant_number': 'maximalCourantNumber', 'maximal_step': 'maximalStep', 'type': 'type'}¶
- property max_alpha_co¶
Gets the max_alpha_co of this ActiveAdjustableTimestep. # noqa: E501
Define a maximum Courant number based on the interface velocity. # noqa: E501
- Returns
The max_alpha_co of this ActiveAdjustableTimestep. # noqa: E501
- Return type
float
- property maximal_courant_number¶
Gets the maximal_courant_number of this ActiveAdjustableTimestep. # noqa: E501
This option defines a maximum Courant number. When using explicit time integration schemes, it may not be greater than 1. Values of 0.5-0.7 are recommended for many cases. # noqa: E501
- Returns
The maximal_courant_number of this ActiveAdjustableTimestep. # noqa: E501
- Return type
float
- property maximal_step¶
Gets the maximal_step of this ActiveAdjustableTimestep. # noqa: E501
This option defines a maximum time step length which may not be exceeded when the time step is adapted during runtime. # noqa: E501
- Returns
The maximal_step of this ActiveAdjustableTimestep. # noqa: E501
- Return type
float
- openapi_types = {'max_alpha_co': 'float', 'maximal_courant_number': 'float', 'maximal_step': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ActiveAdjustableTimestep. # noqa: E501
This option activates an adjustable time step. The time step is being modified according to the Courant number. Schema name: ActiveAdjustableTimestep # noqa: E501
- Returns
The type of this ActiveAdjustableTimestep. # noqa: E501
- Return type
str
simscale_sdk.models.adaptive_augmentation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.adaptive_augmentation.AdaptiveAugmentation(field_change_target_value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_change_target_value': 'fieldChangeTargetValue'}¶
- property field_change_target_value¶
Gets the field_change_target_value of this AdaptiveAugmentation. # noqa: E501
<p>Define the percentage of additional Newton Iterations that should be allowed to be used if convergence is not reached after the maximum number of Newton Iterations is reached.</p> # noqa: E501
- Returns
The field_change_target_value of this AdaptiveAugmentation. # noqa: E501
- Return type
float
- openapi_types = {'field_change_target_value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.additional_directional_cells module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.additional_directional_cells.AdditionalDirectionalCells(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'x': 'int', 'y': 'int', 'z': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this AdditionalDirectionalCells. # noqa: E501
Specify the number of additional cells to be added in the X-direction. Note: additional cells in the negative X direction is not supported. # noqa: E501
- Returns
The x of this AdditionalDirectionalCells. # noqa: E501
- Return type
int
- property y¶
Gets the y of this AdditionalDirectionalCells. # noqa: E501
Specify the number of additional cells to be added in the Y-direction. Note: additional cells in the negative Y direction is not supported. # noqa: E501
- Returns
The y of this AdditionalDirectionalCells. # noqa: E501
- Return type
int
- property z¶
Gets the z of this AdditionalDirectionalCells. # noqa: E501
Specify the number of additional cells to be added in the Z-direction. Note: additional cells in the negative Z direction is not supported. # noqa: E501
- Returns
The z of this AdditionalDirectionalCells. # noqa: E501
- Return type
int
simscale_sdk.models.adiabatic_interface_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.adiabatic_interface_thermal.AdiabaticInterfaceThermal(type='ADIABATIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AdiabaticInterfaceThermal. # noqa: E501
Schema name: AdiabaticInterfaceThermal # noqa: E501
- Returns
The type of this AdiabaticInterfaceThermal. # noqa: E501
- Return type
str
simscale_sdk.models.adiabatic_perfect_fluid_equation_of_state module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.adiabatic_perfect_fluid_equation_of_state.AdiabaticPerfectFluidEquationOfState(type='ADIABATIC_PERFECT_FLUID', reference_pressure=None, reference_density=None, isentropic_exponent=None, pressure_offset=None, energy=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'energy': 'energy', 'isentropic_exponent': 'isentropicExponent', 'pressure_offset': 'pressureOffset', 'reference_density': 'referenceDensity', 'reference_pressure': 'referencePressure', 'type': 'type'}¶
- property energy¶
Gets the energy of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
<p><b>Energy</b> provides the methods for the form of energy to be used. The options are:</p><p><b>Sensible enthalpy:</b> The enthalpy form of equation is used without the heat of formation. In most cases this is the recommended choice.</p><p><b>Sensible internal Energy:</b> The internal energy form of equation is used without the heat of formation but also incorporates energy change due to reactions.</p> # noqa: E501
- Returns
The energy of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Return type
str
- property isentropic_exponent¶
Gets the isentropic_exponent of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
Specify the isentropic exponent. This parameter characterizes changes in density due to pressure. A Larger isentropic exponent results in less sensitivity of the density to reference pressure. # noqa: E501
- Returns
The isentropic_exponent of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Return type
float
- openapi_types = {'energy': 'str', 'isentropic_exponent': 'float', 'pressure_offset': 'DimensionalPressure', 'reference_density': 'DimensionalDensity', 'reference_pressure': 'DimensionalPressure', 'type': 'str'}¶
- property pressure_offset¶
Gets the pressure_offset of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Returns
The pressure_offset of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Return type
- property reference_density¶
Gets the reference_density of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Returns
The reference_density of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Return type
- property reference_pressure¶
Gets the reference_pressure of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Returns
The reference_pressure of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
<br><p>The <b>Equation of state</b> describes the relation between density of a fluid and the fluid pressure and temperature. The available options are:</p><p><b>Rho const:</b> Fluid density is assumed constant.</p><p><b>Incompressibel perfect gas:</b> The fluid is assumed to be an ‘Ideal Gas’ that is incompressible by pressure. But, fluid density can change due to temperature.</p><p><b>Perfect gas:</b> Fluid is assumed to be an ‘Ideal Gas’ and obeys the ‘Ideal Gas Law’.</p><p><b>Perfect fluid:</b> Fluid density can change due to pressure and temperature with respect to a base value.</p><p><b>Adiabatic perfect fluid:</b> The fluid is a perfect fluid which is adiabatic in nature.</p> <a href=’https://www.simscale.com/docs/simulation-setup/materials/thermophysical-fluid-models/#equation-of-state’ target=’_blank’>Learn more</a>. Schema name: AdiabaticPerfectFluidEquationOfState # noqa: E501
- Returns
The type of this AdiabaticPerfectFluidEquationOfState. # noqa: E501
- Return type
str
simscale_sdk.models.adiabatic_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.adiabatic_tbc.AdiabaticTBC(type='ADIABATIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AdiabaticTBC. # noqa: E501
Schema name: AdiabaticTBC # noqa: E501
- Returns
The type of this AdiabaticTBC. # noqa: E501
- Return type
str
simscale_sdk.models.adjustable_runtime_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.adjustable_runtime_write_control.AdjustableRuntimeWriteControl(type='ADJUSTABLE_RUNTIME', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'DimensionalTime'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AdjustableRuntimeWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: AdjustableRuntimeWriteControl # noqa: E501
- Returns
The type of this AdjustableRuntimeWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this AdjustableRuntimeWriteControl. # noqa: E501
- Returns
The write_interval of this AdjustableRuntimeWriteControl. # noqa: E501
- Return type
simscale_sdk.models.advanced_concepts module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advanced_concepts.AdvancedConcepts(rotating_zones=None, porous_mediums=None, solid_body_motions=None, power_sources=None, momentum_sources=None, passive_scalar_sources=None, thermal_resistance_networks=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'momentum_sources': 'momentumSources', 'passive_scalar_sources': 'passiveScalarSources', 'porous_mediums': 'porousMediums', 'power_sources': 'powerSources', 'rotating_zones': 'rotatingZones', 'solid_body_motions': 'solidBodyMotions', 'thermal_resistance_networks': 'thermalResistanceNetworks'}¶
- property momentum_sources¶
Gets the momentum_sources of this AdvancedConcepts. # noqa: E501
- Returns
The momentum_sources of this AdvancedConcepts. # noqa: E501
- Return type
- openapi_types = {'momentum_sources': 'list[AverageVelocityMomentumSource]', 'passive_scalar_sources': 'list[OneOfAdvancedConceptsPassiveScalarSources]', 'porous_mediums': 'list[OneOfAdvancedConceptsPorousMediums]', 'power_sources': 'list[OneOfAdvancedConceptsPowerSources]', 'rotating_zones': 'list[OneOfAdvancedConceptsRotatingZones]', 'solid_body_motions': 'list[OneOfAdvancedConceptsSolidBodyMotions]', 'thermal_resistance_networks': 'list[OneOfAdvancedConceptsThermalResistanceNetworks]'}¶
- property passive_scalar_sources¶
Gets the passive_scalar_sources of this AdvancedConcepts. # noqa: E501
- Returns
The passive_scalar_sources of this AdvancedConcepts. # noqa: E501
- Return type
list[OneOfAdvancedConceptsPassiveScalarSources]
- property porous_mediums¶
Gets the porous_mediums of this AdvancedConcepts. # noqa: E501
- Returns
The porous_mediums of this AdvancedConcepts. # noqa: E501
- Return type
list[OneOfAdvancedConceptsPorousMediums]
- property power_sources¶
Gets the power_sources of this AdvancedConcepts. # noqa: E501
- Returns
The power_sources of this AdvancedConcepts. # noqa: E501
- Return type
list[OneOfAdvancedConceptsPowerSources]
- property rotating_zones¶
Gets the rotating_zones of this AdvancedConcepts. # noqa: E501
- Returns
The rotating_zones of this AdvancedConcepts. # noqa: E501
- Return type
list[OneOfAdvancedConceptsRotatingZones]
- property solid_body_motions¶
Gets the solid_body_motions of this AdvancedConcepts. # noqa: E501
- Returns
The solid_body_motions of this AdvancedConcepts. # noqa: E501
- Return type
list[OneOfAdvancedConceptsSolidBodyMotions]
- property thermal_resistance_networks¶
Gets the thermal_resistance_networks of this AdvancedConcepts. # noqa: E501
- Returns
The thermal_resistance_networks of this AdvancedConcepts. # noqa: E501
- Return type
list[OneOfAdvancedConceptsThermalResistanceNetworks]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.advanced_modelling module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advanced_modelling.AdvancedModelling(surface_roughness=None, porous_objects=None, rotating_walls=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'porous_objects': 'porousObjects', 'rotating_walls': 'rotatingWalls', 'surface_roughness': 'surfaceRoughness'}¶
- openapi_types = {'porous_objects': 'list[OneOfAdvancedModellingPorousObjects]', 'rotating_walls': 'list[RotatingWall]', 'surface_roughness': 'list[SurfaceRoughness]'}¶
- property porous_objects¶
Gets the porous_objects of this AdvancedModelling. # noqa: E501
- Returns
The porous_objects of this AdvancedModelling. # noqa: E501
- Return type
list[OneOfAdvancedModellingPorousObjects]
- property rotating_walls¶
Gets the rotating_walls of this AdvancedModelling. # noqa: E501
- Returns
The rotating_walls of this AdvancedModelling. # noqa: E501
- Return type
list[RotatingWall]
- property surface_roughness¶
Gets the surface_roughness of this AdvancedModelling. # noqa: E501
- Returns
The surface_roughness of this AdvancedModelling. # noqa: E501
- Return type
list[SurfaceRoughness]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.advanced_roi_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advanced_roi_settings.AdvancedROISettings(wind_tunnel_size=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'wind_tunnel_size': 'windTunnelSize'}¶
- openapi_types = {'wind_tunnel_size': 'OneOfAdvancedROISettingsWindTunnelSize'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property wind_tunnel_size¶
Gets the wind_tunnel_size of this AdvancedROISettings. # noqa: E501
- Returns
The wind_tunnel_size of this AdvancedROISettings. # noqa: E501
- Return type
OneOfAdvancedROISettingsWindTunnelSize
simscale_sdk.models.advanced_simmetrix_fluid_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advanced_simmetrix_fluid_settings.AdvancedSimmetrixFluidSettings(small_feature_tolerance=None, gap_elements=None, global_gradation_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gap_elements': 'gapElements', 'global_gradation_rate': 'globalGradationRate', 'small_feature_tolerance': 'smallFeatureTolerance'}¶
- property gap_elements¶
Gets the gap_elements of this AdvancedSimmetrixFluidSettings. # noqa: E501
<p>Define a target number of elements across the thickness of thin gaps. <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#gap-refinement-factor’ target=’_blank’>Learn more</a>.<img src=”/spec/resources/help/imgs/simmetrix-gap-elements.png” class=”helpPopupImage”/>Example of gap refinements applied with a target of 4 elements across the thickness</p> # noqa: E501
- Returns
The gap_elements of this AdvancedSimmetrixFluidSettings. # noqa: E501
- Return type
float
- property global_gradation_rate¶
Gets the global_gradation_rate of this AdvancedSimmetrixFluidSettings. # noqa: E501
<p>Adjust the transition from small to large cells. This value is the ratio between the size of two adjacent cells. The allowed range is 1.0 - 3.0. 1.0 would produce a uniform mesh with the smallest size everywhere. This is generally not recommended, as it may produce very large meshes.</p> # noqa: E501
- Returns
The global_gradation_rate of this AdvancedSimmetrixFluidSettings. # noqa: E501
- Return type
float
- openapi_types = {'gap_elements': 'float', 'global_gradation_rate': 'float', 'small_feature_tolerance': 'DimensionalLength'}¶
- property small_feature_tolerance¶
Gets the small_feature_tolerance of this AdvancedSimmetrixFluidSettings. # noqa: E501
- Returns
The small_feature_tolerance of this AdvancedSimmetrixFluidSettings. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.advanced_simmetrix_solid_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advanced_simmetrix_solid_settings.AdvancedSimmetrixSolidSettings(small_feature_tolerance=None, gap_elements=None, global_gradation_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gap_elements': 'gapElements', 'global_gradation_rate': 'globalGradationRate', 'small_feature_tolerance': 'smallFeatureTolerance'}¶
- property gap_elements¶
Gets the gap_elements of this AdvancedSimmetrixSolidSettings. # noqa: E501
<p>Define a target number of elements across the thickness of thin gaps. <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#gap-refinement-factor’ target=’_blank’>Learn more</a>.<img src=”/spec/resources/help/imgs/simmetrix-gap-elements.png” class=”helpPopupImage”/>Example of gap refinements applied with a target of 4 elements across the thickness</p> # noqa: E501
- Returns
The gap_elements of this AdvancedSimmetrixSolidSettings. # noqa: E501
- Return type
float
- property global_gradation_rate¶
Gets the global_gradation_rate of this AdvancedSimmetrixSolidSettings. # noqa: E501
<p>Adjust the transition from small to large cells. This value is the ratio between the size of two adjacent cells. The allowed range is 1.0 - 3.0. 1.0 would produce a uniform mesh with the smallest size everywhere. This is generally not recommended, as it may produce very large meshes.</p> # noqa: E501
- Returns
The global_gradation_rate of this AdvancedSimmetrixSolidSettings. # noqa: E501
- Return type
float
- openapi_types = {'gap_elements': 'float', 'global_gradation_rate': 'float', 'small_feature_tolerance': 'DimensionalLength'}¶
- property small_feature_tolerance¶
Gets the small_feature_tolerance of this AdvancedSimmetrixSolidSettings. # noqa: E501
- Returns
The small_feature_tolerance of this AdvancedSimmetrixSolidSettings. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.advective_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advective_pbc.AdvectivePBC(type='ADVECTIVE', relax_boundary=None, far_field_value=None, relaxation_length_scale=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'far_field_value': 'farFieldValue', 'relax_boundary': 'relaxBoundary', 'relaxation_length_scale': 'relaxationLengthScale', 'type': 'type'}¶
- property far_field_value¶
Gets the far_field_value of this AdvectivePBC. # noqa: E501
- Returns
The far_field_value of this AdvectivePBC. # noqa: E501
- Return type
- openapi_types = {'far_field_value': 'DimensionalPressure', 'relax_boundary': 'bool', 'relaxation_length_scale': 'DimensionalLength', 'type': 'str'}¶
- property relax_boundary¶
Gets the relax_boundary of this AdvectivePBC. # noqa: E501
- Returns
The relax_boundary of this AdvectivePBC. # noqa: E501
- Return type
bool
- property relaxation_length_scale¶
Gets the relaxation_length_scale of this AdvectivePBC. # noqa: E501
- Returns
The relaxation_length_scale of this AdvectivePBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AdvectivePBC. # noqa: E501
Schema name: AdvectivePBC # noqa: E501
- Returns
The type of this AdvectivePBC. # noqa: E501
- Return type
str
simscale_sdk.models.advective_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.advective_vbc.AdvectiveVBC(type='ADVECTIVE', relax_boundary=None, far_field_value=None, relaxation_length_scale=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'far_field_value': 'farFieldValue', 'relax_boundary': 'relaxBoundary', 'relaxation_length_scale': 'relaxationLengthScale', 'type': 'type'}¶
- property far_field_value¶
Gets the far_field_value of this AdvectiveVBC. # noqa: E501
- Returns
The far_field_value of this AdvectiveVBC. # noqa: E501
- Return type
- openapi_types = {'far_field_value': 'DimensionalVectorSpeed', 'relax_boundary': 'bool', 'relaxation_length_scale': 'DimensionalLength', 'type': 'str'}¶
- property relax_boundary¶
Gets the relax_boundary of this AdvectiveVBC. # noqa: E501
- Returns
The relax_boundary of this AdvectiveVBC. # noqa: E501
- Return type
bool
- property relaxation_length_scale¶
Gets the relaxation_length_scale of this AdvectiveVBC. # noqa: E501
- Returns
The relaxation_length_scale of this AdvectiveVBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AdvectiveVBC. # noqa: E501
Schema name: AdvectiveVBC # noqa: E501
- Returns
The type of this AdvectiveVBC. # noqa: E501
- Return type
str
simscale_sdk.models.algorithm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.algorithm.Algorithm(type='HEX_DOMINANT_SNAPPY_V5', sizing=None, refinements=None, cell_zones=None, automatic_layer_settings=None, physics_based_meshing=None, hex_core=None, num_of_processors=None, advanced_simmetrix_settings=None, second_order=None, enable_shell_meshing=None, surface_element_type=None, meshing_mode=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_simmetrix_settings¶
Gets the advanced_simmetrix_settings of this Algorithm. # noqa: E501
- Returns
The advanced_simmetrix_settings of this Algorithm. # noqa: E501
- Return type
- attribute_map = {'advanced_simmetrix_settings': 'advancedSimmetrixSettings', 'automatic_layer_settings': 'automaticLayerSettings', 'cell_zones': 'cellZones', 'enable_shell_meshing': 'enableShellMeshing', 'hex_core': 'hexCore', 'meshing_mode': 'meshingMode', 'num_of_processors': 'numOfProcessors', 'physics_based_meshing': 'physicsBasedMeshing', 'refinements': 'refinements', 'second_order': 'secondOrder', 'sizing': 'sizing', 'surface_element_type': 'surfaceElementType', 'type': 'type'}¶
- property automatic_layer_settings¶
Gets the automatic_layer_settings of this Algorithm. # noqa: E501
- Returns
The automatic_layer_settings of this Algorithm. # noqa: E501
- Return type
OneOfSimmetrixMeshingFluidAutomaticLayerSettings
- property cell_zones¶
Gets the cell_zones of this Algorithm. # noqa: E501
- Returns
The cell_zones of this Algorithm. # noqa: E501
- Return type
list[SimmetrixCellZones]
- discriminator_value_class_map = {'HEX_DOMINANT_SNAPPY_V5': 'HexDominantSnappy', 'SIMMETRIX_MESHING_FLUID_V16': 'SimmetrixMeshingFluid', 'SIMMETRIX_MESHING_SOLID': 'SimmetrixMeshingSolid'}¶
- property enable_shell_meshing¶
Gets the enable_shell_meshing of this Algorithm. # noqa: E501
- Returns
The enable_shell_meshing of this Algorithm. # noqa: E501
- Return type
bool
- get_real_child_model(data)¶
Returns the real base class specified by the discriminator
- property hex_core¶
Gets the hex_core of this Algorithm. # noqa: E501
<p>If <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#hexcore’ target=’_blank’><b>Hex element core</b></a> is activated, the interior of the mesh gets covered by <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#hexcore’ target=’_blank’><b>hexahedral elements</b></a>. The transition to the triangulated surface mesh is covered by tetrahedral and pyramid elements.<img src=”/spec/resources/help/imgs/simmetrix-hexcore.png” class=”helpPopupImage”/>Meshclip through a hex-core mesh.</p> # noqa: E501
- Returns
The hex_core of this Algorithm. # noqa: E501
- Return type
bool
- property meshing_mode¶
Gets the meshing_mode of this Algorithm. # noqa: E501
<p>The <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#meshing-mode’ target=’_blank’>meshing mode</a> defines how the mesher should generate the mesh.</p><ul><li>The <b>Internal</b> mode will create the mesh <u>inside</u> of the geometry body. If the CAD consists of multiple solids, the mesher will attempt to create a multiregion mesh which is suitable for conjugate heat transfer analyses. Use this mode if the CAD model already represents the final fluid domain.</li><li><b>External</b> meshing will create the mesh <u>outside</u> of the bodies. The absolute dimensions of the mesh are determined by the <i>Background Mesh Box</i>. Use this mode in case you want to extract the fluid domain around your model.</li><li>The option <b>Material point</b> allows you to define a point inside the domain where the mesh will be placed. It can be used to select which part (or enclosed volume) of the model or should be meshed. The mesh will surround the material point and extend until the boundaries of the body. The location of the material point is defined by the <i>Material Point</i> geometry primitive.</li></ul> # noqa: E501
- Returns
The meshing_mode of this Algorithm. # noqa: E501
- Return type
str
- property num_of_processors¶
Gets the num_of_processors of this Algorithm. # noqa: E501
<p>Selecting more processor cores might speed up the meshing process. Choosing a smaller computation instance will save core hours. <a href=’https://www.simscale.com/docs/simulation-setup/meshing/#number-of-processors’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The num_of_processors of this Algorithm. # noqa: E501
- Return type
int
- openapi_types = {'advanced_simmetrix_settings': 'AdvancedSimmetrixSolidSettings', 'automatic_layer_settings': 'OneOfSimmetrixMeshingFluidAutomaticLayerSettings', 'cell_zones': 'list[SimmetrixCellZones]', 'enable_shell_meshing': 'bool', 'hex_core': 'bool', 'meshing_mode': 'str', 'num_of_processors': 'int', 'physics_based_meshing': 'bool', 'refinements': 'list[OneOfHexDominantSnappyRefinements]', 'second_order': 'bool', 'sizing': 'OneOfHexDominantSnappySizing', 'surface_element_type': 'str', 'type': 'str'}¶
- property physics_based_meshing¶
Gets the physics_based_meshing of this Algorithm. # noqa: E501
Physics-based meshing takes setup information like materials, boundary conditions, and source terms into account to size the mesh accordingly. When enabled, the following adaptations will be made:</p><ul><li>Refinements on inlets and outlets</li><li>Different sizing for solid and fluid regions in CHT simulations</li></ul> <br>When toggled on users don’t have to worry about creating a <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control/’ target=’_blank’>separate cell zone</a>. # noqa: E501
- Returns
The physics_based_meshing of this Algorithm. # noqa: E501
- Return type
bool
- property refinements¶
Gets the refinements of this Algorithm. # noqa: E501
- Returns
The refinements of this Algorithm. # noqa: E501
- Return type
list[OneOfHexDominantSnappyRefinements]
- property second_order¶
Gets the second_order of this Algorithm. # noqa: E501
<p>The <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#order’ target=’_blank’><b>mesh order</b></a> defines the shape and the number of nodes of the mesh elements. For a fast, rough analysis choose <i>first order</i> only. Activate <i>2nd order elements</i> for higher quality results</p> # noqa: E501
- Returns
The second_order of this Algorithm. # noqa: E501
- Return type
bool
- property sizing¶
Gets the sizing of this Algorithm. # noqa: E501
- Returns
The sizing of this Algorithm. # noqa: E501
- Return type
OneOfHexDominantSnappySizing
- property surface_element_type¶
Gets the surface_element_type of this Algorithm. # noqa: E501
- Returns
The surface_element_type of this Algorithm. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Algorithm. # noqa: E501
Schema name: HexDominantSnappy # noqa: E501
- Returns
The type of this Algorithm. # noqa: E501
- Return type
str
simscale_sdk.models.all_computed_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.all_computed_write_control.AllComputedWriteControl(type='ALL_COMPUTED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AllComputedWriteControl. # noqa: E501
<p>Define how frequently intermediate results should be saved. With the selection of <b>initial time steps</b> only the user defined time steps are stored in the result and by selecting <b>all computed time steps</b> also intermediate results that were created by the automatic time stepping are saved. With the selection of <b>write interval</b> a specific write frequency can be chosen which reduces the result size. Finally using <b>user defined time steps</b> there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the <b>time step length</b> definition.</p> Schema name: AllComputedWriteControl # noqa: E501
- Returns
The type of this AllComputedWriteControl. # noqa: E501
- Return type
str
simscale_sdk.models.ambient_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ambient_pbc.AmbientPBC(type='AMBIENT_PRESSURE', ambient_pressure=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property ambient_pressure¶
Gets the ambient_pressure of this AmbientPBC. # noqa: E501
- Returns
The ambient_pressure of this AmbientPBC. # noqa: E501
- Return type
- attribute_map = {'ambient_pressure': 'ambientPressure', 'type': 'type'}¶
- openapi_types = {'ambient_pressure': 'DimensionalPressure', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AmbientPBC. # noqa: E501
Schema name: AmbientPBC # noqa: E501
- Returns
The type of this AmbientPBC. # noqa: E501
- Return type
str
simscale_sdk.models.ambient_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ambient_tbc.AmbientTBC(type='AMBIENT_TEMPERATURE', ambient_temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property ambient_temperature¶
Gets the ambient_temperature of this AmbientTBC. # noqa: E501
- Returns
The ambient_temperature of this AmbientTBC. # noqa: E501
- Return type
- attribute_map = {'ambient_temperature': 'ambientTemperature', 'type': 'type'}¶
- openapi_types = {'ambient_temperature': 'DimensionalTemperature', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AmbientTBC. # noqa: E501
Schema name: AmbientTBC # noqa: E501
- Returns
The type of this AmbientTBC. # noqa: E501
- Return type
str
simscale_sdk.models.ami_rotating_zone module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ami_rotating_zone.AMIRotatingZone(type='ARBITRARY_MESH_INTERFACE', name=None, motion_type=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'motion_type': 'motionType', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property motion_type¶
Gets the motion_type of this AMIRotatingZone. # noqa: E501
- Returns
The motion_type of this AMIRotatingZone. # noqa: E501
- Return type
OneOfAMIRotatingZoneMotionType
- property name¶
Gets the name of this AMIRotatingZone. # noqa: E501
- Returns
The name of this AMIRotatingZone. # noqa: E501
- Return type
str
- openapi_types = {'motion_type': 'OneOfAMIRotatingZoneMotionType', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AMIRotatingZone. # noqa: E501
- Returns
The topological_reference of this AMIRotatingZone. # noqa: E501
- Return type
- property type¶
Gets the type of this AMIRotatingZone. # noqa: E501
Schema name: AMIRotatingZone # noqa: E501
- Returns
The type of this AMIRotatingZone. # noqa: E501
- Return type
str
simscale_sdk.models.analysis module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.analysis.Analysis(type='FREQUENCY_ANALYSIS', non_linear_analysis=None, connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, time_dependency=None, inertia_effect=None, turbulence_model=None, algorithm=None, num_of_passive_species=None, enable_adjoint_optimization=None, advanced_concepts=None, bounding_box_uuid=None, material=None, flow_domain_boundaries=None, advanced_modelling=None, mesh_settings_new=None, is_compressible=None, cavitation_model=None, mesh_settings=None, region_of_interest=None, wind_conditions=None, pedestrian_comfort_map=None, additional_result_export=None, enable_radiation=None, contact_handling_mode=None, enable_solar_load=None, solar_calculator=None, is_internal_flow=None, use_local_time_stepping=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property additional_result_export¶
Gets the additional_result_export of this Analysis. # noqa: E501
- Returns
The additional_result_export of this Analysis. # noqa: E501
- Return type
- property advanced_concepts¶
Gets the advanced_concepts of this Analysis. # noqa: E501
- Returns
The advanced_concepts of this Analysis. # noqa: E501
- Return type
- property advanced_modelling¶
Gets the advanced_modelling of this Analysis. # noqa: E501
- Returns
The advanced_modelling of this Analysis. # noqa: E501
- Return type
- property algorithm¶
Gets the algorithm of this Analysis. # noqa: E501
- Returns
The algorithm of this Analysis. # noqa: E501
- Return type
str
- attribute_map = {'additional_result_export': 'additionalResultExport', 'advanced_concepts': 'advancedConcepts', 'advanced_modelling': 'advancedModelling', 'algorithm': 'algorithm', 'boundary_conditions': 'boundaryConditions', 'bounding_box_uuid': 'boundingBoxUuid', 'cavitation_model': 'cavitationModel', 'connection_groups': 'connectionGroups', 'contact_handling_mode': 'contactHandlingMode', 'element_technology': 'elementTechnology', 'enable_adjoint_optimization': 'enableAdjointOptimization', 'enable_radiation': 'enableRadiation', 'enable_solar_load': 'enableSolarLoad', 'flow_domain_boundaries': 'flowDomainBoundaries', 'inertia_effect': 'inertiaEffect', 'initial_conditions': 'initialConditions', 'is_compressible': 'isCompressible', 'is_internal_flow': 'isInternalFlow', 'material': 'material', 'materials': 'materials', 'mesh_order': 'meshOrder', 'mesh_settings': 'meshSettings', 'mesh_settings_new': 'meshSettingsNew', 'model': 'model', 'non_linear_analysis': 'nonLinearAnalysis', 'num_of_passive_species': 'numOfPassiveSpecies', 'numerics': 'numerics', 'pedestrian_comfort_map': 'pedestrianComfortMap', 'region_of_interest': 'regionOfInterest', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'solar_calculator': 'solarCalculator', 'time_dependency': 'timeDependency', 'turbulence_model': 'turbulenceModel', 'type': 'type', 'use_local_time_stepping': 'useLocalTimeStepping', 'wind_conditions': 'windConditions'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this Analysis. # noqa: E501
- Returns
The boundary_conditions of this Analysis. # noqa: E501
- Return type
list[OneOfFrequencyAnalysisBoundaryConditions]
- property bounding_box_uuid¶
Gets the bounding_box_uuid of this Analysis. # noqa: E501
- Returns
The bounding_box_uuid of this Analysis. # noqa: E501
- Return type
str
- property cavitation_model¶
Gets the cavitation_model of this Analysis. # noqa: E501
- Returns
The cavitation_model of this Analysis. # noqa: E501
- Return type
str
- property connection_groups¶
Gets the connection_groups of this Analysis. # noqa: E501
- Returns
The connection_groups of this Analysis. # noqa: E501
- Return type
list[Contact]
- property contact_handling_mode¶
Gets the contact_handling_mode of this Analysis. # noqa: E501
- Returns
The contact_handling_mode of this Analysis. # noqa: E501
- Return type
str
- discriminator_value_class_map = {'COMPRESSIBLE': 'Compressible', 'CONJUGATE_HEAT_TRANSFER': 'ConjugateHeatTransfer', 'CONVECTIVE_HEAT_TRANSFER': 'ConvectiveHeatTransfer', 'COUPLED_CONJUGATE_HEAT_TRANSFER': 'CoupledConjugateHeatTransfer', 'DYNAMIC_ANALYSIS': 'DynamicAnalysis', 'EMBEDDED_BOUNDARY': 'EmbeddedBoundary', 'FREQUENCY_ANALYSIS': 'FrequencyAnalysis', 'HARMONIC_ANALYSIS': 'HarmonicAnalysis', 'HEAT_TRANSFER': 'HeatTransfer', 'INCOMPRESSIBLE': 'Incompressible', 'INCOMPRESSIBLE_PACEFISH': 'IncompressiblePacefish', 'MULTIPHASE': 'Multiphase', 'SIMERICS_ANALYSIS': 'SimericsAnalysis', 'STATIC_ANALYSIS': 'StaticAnalysis', 'THERMAL_MECHANICAL': 'ThermalMechanical', 'WIND_COMFORT': 'WindComfort'}¶
- property element_technology¶
Gets the element_technology of this Analysis. # noqa: E501
- Returns
The element_technology of this Analysis. # noqa: E501
- Return type
- property enable_adjoint_optimization¶
Gets the enable_adjoint_optimization of this Analysis. # noqa: E501
- Returns
The enable_adjoint_optimization of this Analysis. # noqa: E501
- Return type
bool
- property enable_radiation¶
Gets the enable_radiation of this Analysis. # noqa: E501
Heat transfer through radiation takes place in the form of electromagnetic waves and it can be calculated in the simulation. This phenomenon becomes more important when the temperatures involved in the simulation are large. <a href=’https://www.simscale.com/docs/analysis-types/convective-heat-transfer-analysis/radiation/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_radiation of this Analysis. # noqa: E501
- Return type
bool
- property enable_solar_load¶
Gets the enable_solar_load of this Analysis. # noqa: E501
<b>Solar load</b> on boundary patches. Heats boundaries externally or, if solar rays enter the domain by transparent or semi-transparent boundaries, it heats boundaries also internally, internally. Sun direction and solar load model are defined in the <b>Solar calculator</b>. <ul><li>Can not be combined with surface to surface radiation.</li><li>Can only be used for convective heat transfer.</li><li>Secondary, reflecting rays are not taken into account.</li></ul> <a href=’https://www.simscale.com/docs/analysis-types/conjugate-heat-transfer-analysis/solar-load/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_solar_load of this Analysis. # noqa: E501
- Return type
bool
- property flow_domain_boundaries¶
Gets the flow_domain_boundaries of this Analysis. # noqa: E501
- Returns
The flow_domain_boundaries of this Analysis. # noqa: E501
- Return type
- get_real_child_model(data)¶
Returns the real base class specified by the discriminator
- property inertia_effect¶
Gets the inertia_effect of this Analysis. # noqa: E501
<p>Select if inertia effects should be considered in the analysis. If high loading accelerations or impacts are present then <b>dynamic</b> is the right choice for this parameter. If the dynamic effects are negligible, <b>static</b> should be selected.</p> # noqa: E501
- Returns
The inertia_effect of this Analysis. # noqa: E501
- Return type
str
- property initial_conditions¶
Gets the initial_conditions of this Analysis. # noqa: E501
- Returns
The initial_conditions of this Analysis. # noqa: E501
- Return type
- property is_compressible¶
Gets the is_compressible of this Analysis. # noqa: E501
<ul><li>Toggle off <em>Compressible</em> for small temperature variations within the domain, for example, in natural convection simulations (Boussinesq approximation). Use Gauge pressure (0 Pa). </li><li>Toggle on <em>Compressible</em> to calculate resulting density variations within the domain based on pressure and temperature. Use Absolute pressure (for example, 101325 Pa at sea level)</li></ul> # noqa: E501
- Returns
The is_compressible of this Analysis. # noqa: E501
- Return type
bool
- property is_internal_flow¶
Gets the is_internal_flow of this Analysis. # noqa: E501
If active it indicates that the fluid region is contained within the uploaded geometry. # noqa: E501
- Returns
The is_internal_flow of this Analysis. # noqa: E501
- Return type
bool
- property material¶
Gets the material of this Analysis. # noqa: E501
- Returns
The material of this Analysis. # noqa: E501
- Return type
- property materials¶
Gets the materials of this Analysis. # noqa: E501
- Returns
The materials of this Analysis. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this Analysis. # noqa: E501
- Returns
The mesh_order of this Analysis. # noqa: E501
- Return type
str
- property mesh_settings¶
Gets the mesh_settings of this Analysis. # noqa: E501
- Returns
The mesh_settings of this Analysis. # noqa: E501
- Return type
- property mesh_settings_new¶
Gets the mesh_settings_new of this Analysis. # noqa: E501
- Returns
The mesh_settings_new of this Analysis. # noqa: E501
- Return type
OneOfIncompressiblePacefishMeshSettingsNew
- property model¶
Gets the model of this Analysis. # noqa: E501
- Returns
The model of this Analysis. # noqa: E501
- Return type
- property non_linear_analysis¶
Gets the non_linear_analysis of this Analysis. # noqa: E501
<p>Choose if your analysis should feature any kind of <b>nonlinearity</b> like <b>physical contacts, nonlinear materials</b> as hyperelasticity or plasticity or <b>large rotations</b> and <b>large deformations, temperature dependant material properties</b> or <b>temperature dependant boundary conditions</b>. For a <b>linear analysis</b> none of those nonlinearities are available.</p> # noqa: E501
- Returns
The non_linear_analysis of this Analysis. # noqa: E501
- Return type
bool
- property num_of_passive_species¶
Gets the num_of_passive_species of this Analysis. # noqa: E501
Select the number of passive species involved in the simulation. Passive species allow you to simulate the transport of a scalar quantity within a fluid flow without affecting it. <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/#passive-species’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The num_of_passive_species of this Analysis. # noqa: E501
- Return type
int
- property numerics¶
Gets the numerics of this Analysis. # noqa: E501
- Returns
The numerics of this Analysis. # noqa: E501
- Return type
- openapi_types = {'additional_result_export': 'FluidResultControls', 'advanced_concepts': 'AdvancedConcepts', 'advanced_modelling': 'AdvancedModelling', 'algorithm': 'str', 'boundary_conditions': 'list[OneOfFrequencyAnalysisBoundaryConditions]', 'bounding_box_uuid': 'str', 'cavitation_model': 'str', 'connection_groups': 'list[Contact]', 'contact_handling_mode': 'str', 'element_technology': 'SolidElementTechnology', 'enable_adjoint_optimization': 'bool', 'enable_radiation': 'bool', 'enable_solar_load': 'bool', 'flow_domain_boundaries': 'FlowDomainBoundaries', 'inertia_effect': 'str', 'initial_conditions': 'SolidInitialConditions', 'is_compressible': 'bool', 'is_internal_flow': 'bool', 'material': 'IncompressibleMaterial', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'mesh_settings': 'BasicEmbeddedBoundaryMeshing', 'mesh_settings_new': 'OneOfIncompressiblePacefishMeshSettingsNew', 'model': 'SolidModel', 'non_linear_analysis': 'bool', 'num_of_passive_species': 'int', 'numerics': 'SolidNumerics', 'pedestrian_comfort_map': 'list[PedestrianComfortSurface]', 'region_of_interest': 'RegionOfInterest', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'solar_calculator': 'SolarCalculator', 'time_dependency': 'OneOfConjugateHeatTransferTimeDependency', 'turbulence_model': 'str', 'type': 'str', 'use_local_time_stepping': 'bool', 'wind_conditions': 'WindConditions'}¶
- property pedestrian_comfort_map¶
Gets the pedestrian_comfort_map of this Analysis. # noqa: E501
- Returns
The pedestrian_comfort_map of this Analysis. # noqa: E501
- Return type
list[PedestrianComfortSurface]
- property region_of_interest¶
Gets the region_of_interest of this Analysis. # noqa: E501
- Returns
The region_of_interest of this Analysis. # noqa: E501
- Return type
- property result_control¶
Gets the result_control of this Analysis. # noqa: E501
- Returns
The result_control of this Analysis. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this Analysis. # noqa: E501
- Returns
The simulation_control of this Analysis. # noqa: E501
- Return type
- property solar_calculator¶
Gets the solar_calculator of this Analysis. # noqa: E501
- Returns
The solar_calculator of this Analysis. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this Analysis. # noqa: E501
- Returns
The time_dependency of this Analysis. # noqa: E501
- Return type
OneOfConjugateHeatTransferTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this Analysis. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this Analysis. # noqa: E501
- Return type
str
- property type¶
Gets the type of this Analysis. # noqa: E501
Schema name: FrequencyAnalysis # noqa: E501
- Returns
The type of this Analysis. # noqa: E501
- Return type
str
- property use_local_time_stepping¶
Gets the use_local_time_stepping of this Analysis. # noqa: E501
With the <i>Local time stepping</i> option enabled, it’s possible to accelerate the simulation towards a steady-state. As a result, faster computing times and smaller result data size. Commonly used in ship hull resistance analysis. # noqa: E501
- Returns
The use_local_time_stepping of this Analysis. # noqa: E501
- Return type
bool
- property wind_conditions¶
Gets the wind_conditions of this Analysis. # noqa: E501
- Returns
The wind_conditions of this Analysis. # noqa: E501
- Return type
simscale_sdk.models.angular_rotation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.angular_rotation.AngularRotation(type='ANGULAR_ROTATION', rotation_center=None, rotation_axis=None, angular_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property angular_velocity¶
Gets the angular_velocity of this AngularRotation. # noqa: E501
- Returns
The angular_velocity of this AngularRotation. # noqa: E501
- Return type
- attribute_map = {'angular_velocity': 'angularVelocity', 'rotation_axis': 'rotationAxis', 'rotation_center': 'rotationCenter', 'type': 'type'}¶
- openapi_types = {'angular_velocity': 'DimensionalFunctionRotationSpeed', 'rotation_axis': 'DimensionalVectorLength', 'rotation_center': 'DimensionalVectorLength', 'type': 'str'}¶
- property rotation_axis¶
Gets the rotation_axis of this AngularRotation. # noqa: E501
- Returns
The rotation_axis of this AngularRotation. # noqa: E501
- Return type
- property rotation_center¶
Gets the rotation_center of this AngularRotation. # noqa: E501
- Returns
The rotation_center of this AngularRotation. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AngularRotation. # noqa: E501
Schema name: AngularRotation # noqa: E501
- Returns
The type of this AngularRotation. # noqa: E501
- Return type
str
simscale_sdk.models.animation_output_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.animation_output_settings.AnimationOutputSettings(name=None, format='GIF', resolution=None, frame_rate=20, show_legend=True, show_cube=True, background_color=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'background_color': 'backgroundColor', 'format': 'format', 'frame_rate': 'frameRate', 'name': 'name', 'resolution': 'resolution', 'show_cube': 'showCube', 'show_legend': 'showLegend'}¶
- property background_color¶
Gets the background_color of this AnimationOutputSettings. # noqa: E501
- Returns
The background_color of this AnimationOutputSettings. # noqa: E501
- Return type
- property format¶
Gets the format of this AnimationOutputSettings. # noqa: E501
- Returns
The format of this AnimationOutputSettings. # noqa: E501
- Return type
str
- property frame_rate¶
Gets the frame_rate of this AnimationOutputSettings. # noqa: E501
- Returns
The frame_rate of this AnimationOutputSettings. # noqa: E501
- Return type
int
- property name¶
Gets the name of this AnimationOutputSettings. # noqa: E501
- Returns
The name of this AnimationOutputSettings. # noqa: E501
- Return type
str
- openapi_types = {'background_color': 'Color', 'format': 'str', 'frame_rate': 'int', 'name': 'str', 'resolution': 'ResolutionInfo', 'show_cube': 'bool', 'show_legend': 'bool'}¶
- property resolution¶
Gets the resolution of this AnimationOutputSettings. # noqa: E501
- Returns
The resolution of this AnimationOutputSettings. # noqa: E501
- Return type
- property show_cube¶
Gets the show_cube of this AnimationOutputSettings. # noqa: E501
- Returns
The show_cube of this AnimationOutputSettings. # noqa: E501
- Return type
bool
- property show_legend¶
Gets the show_legend of this AnimationOutputSettings. # noqa: E501
- Returns
The show_legend of this AnimationOutputSettings. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.animation_report_properties module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.animation_report_properties.AnimationReportProperties(report_type='ANIMATION', model_settings=None, filters=None, camera_settings=None, output_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'camera_settings': 'cameraSettings', 'filters': 'filters', 'model_settings': 'modelSettings', 'output_settings': 'outputSettings', 'report_type': 'reportType'}¶
- property camera_settings¶
Gets the camera_settings of this AnimationReportProperties. # noqa: E501
- Returns
The camera_settings of this AnimationReportProperties. # noqa: E501
- Return type
OneOfCameraSettings
- property filters¶
Gets the filters of this AnimationReportProperties. # noqa: E501
- Returns
The filters of this AnimationReportProperties. # noqa: E501
- Return type
- property model_settings¶
Gets the model_settings of this AnimationReportProperties. # noqa: E501
- Returns
The model_settings of this AnimationReportProperties. # noqa: E501
- Return type
- openapi_types = {'camera_settings': 'OneOfCameraSettings', 'filters': 'Filters', 'model_settings': 'ModelSettings', 'output_settings': 'OneOfAnimationOutputSettings', 'report_type': 'str'}¶
- property output_settings¶
Gets the output_settings of this AnimationReportProperties. # noqa: E501
- Returns
The output_settings of this AnimationReportProperties. # noqa: E501
- Return type
OneOfAnimationOutputSettings
- property report_type¶
Gets the report_type of this AnimationReportProperties. # noqa: E501
- Returns
The report_type of this AnimationReportProperties. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.any_of_parameter_with_values_values module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.any_of_parameter_with_values_values.AnyOfParameterWithValuesValues(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.area_average_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.area_average_result_control.AreaAverageResultControl(type='AREA_AVERAGE', name=None, write_control=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type', 'write_control': 'writeControl'}¶
- property name¶
Gets the name of this AreaAverageResultControl. # noqa: E501
- Returns
The name of this AreaAverageResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str', 'write_control': 'OneOfAreaAverageResultControlWriteControl'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AreaAverageResultControl. # noqa: E501
- Returns
The topological_reference of this AreaAverageResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this AreaAverageResultControl. # noqa: E501
Schema name: AreaAverageResultControl # noqa: E501
- Returns
The type of this AreaAverageResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this AreaAverageResultControl. # noqa: E501
- Returns
The write_control of this AreaAverageResultControl. # noqa: E501
- Return type
OneOfAreaAverageResultControlWriteControl
simscale_sdk.models.area_integral_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.area_integral_result_control.AreaIntegralResultControl(type='AREA_INTEGRAL', name=None, write_control=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type', 'write_control': 'writeControl'}¶
- property name¶
Gets the name of this AreaIntegralResultControl. # noqa: E501
- Returns
The name of this AreaIntegralResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str', 'write_control': 'OneOfAreaIntegralResultControlWriteControl'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AreaIntegralResultControl. # noqa: E501
- Returns
The topological_reference of this AreaIntegralResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this AreaIntegralResultControl. # noqa: E501
Schema name: AreaIntegralResultControl # noqa: E501
- Returns
The type of this AreaIntegralResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this AreaIntegralResultControl. # noqa: E501
- Returns
The write_control of this AreaIntegralResultControl. # noqa: E501
- Return type
OneOfAreaIntegralResultControlWriteControl
simscale_sdk.models.atmospheric_boundary_layer_inlet_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.atmospheric_boundary_layer_inlet_bc.AtmosphericBoundaryLayerInletBC(type='ATMOSPHERIC_BOUNDARY_LAYER_INLET', name=None, reference_velocity=None, reference_height=None, ground_roughness=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'ground_roughness': 'groundRoughness', 'name': 'name', 'reference_height': 'referenceHeight', 'reference_velocity': 'referenceVelocity', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property ground_roughness¶
Gets the ground_roughness of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Returns
The ground_roughness of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Return type
- property name¶
Gets the name of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Returns
The name of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Return type
str
- openapi_types = {'ground_roughness': 'DimensionalLength', 'name': 'str', 'reference_height': 'DimensionalLength', 'reference_velocity': 'DimensionalSpeed', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property reference_height¶
Gets the reference_height of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Returns
The reference_height of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Return type
- property reference_velocity¶
Gets the reference_velocity of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Returns
The reference_velocity of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Returns
The topological_reference of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Return type
- property type¶
Gets the type of this AtmosphericBoundaryLayerInletBC. # noqa: E501
The atmospheric boundary layer boundary condition implements the standard logarithmic profile for the stream-wise wind velocity component with corresponding profiles for turbulence kinetic energy and specific dissipation rate, where the ground roughness effects are taken into account. Schema name: AtmosphericBoundaryLayerInletBC # noqa: E501
- Returns
The type of this AtmosphericBoundaryLayerInletBC. # noqa: E501
- Return type
str
simscale_sdk.models.augmented_lagrange_method module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.augmented_lagrange_method.AugmentedLagrangeMethod(type='AUGMENTED_LAGRANGE', augmented_lagrange_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'augmented_lagrange_coefficient': 'augmentedLagrangeCoefficient', 'type': 'type'}¶
- property augmented_lagrange_coefficient¶
Gets the augmented_lagrange_coefficient of this AugmentedLagrangeMethod. # noqa: E501
- Returns
The augmented_lagrange_coefficient of this AugmentedLagrangeMethod. # noqa: E501
- Return type
float
- openapi_types = {'augmented_lagrange_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AugmentedLagrangeMethod. # noqa: E501
Schema name: AugmentedLagrangeMethod # noqa: E501
- Returns
The type of this AugmentedLagrangeMethod. # noqa: E501
- Return type
str
simscale_sdk.models.auto_timestep_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.auto_timestep_definition.AutoTimestepDefinition(type='AUTOMATIC_V27', simulation_interval=None, maximum_timestep_length=None, minimum_timestep_length=None, maximum_residual=None, retiming_event=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'maximum_residual': 'maximumResidual', 'maximum_timestep_length': 'maximumTimestepLength', 'minimum_timestep_length': 'minimumTimestepLength', 'retiming_event': 'retimingEvent', 'simulation_interval': 'simulationInterval', 'type': 'type'}¶
- property maximum_residual¶
Gets the maximum_residual of this AutoTimestepDefinition. # noqa: E501
- Returns
The maximum_residual of this AutoTimestepDefinition. # noqa: E501
- Return type
float
- property maximum_timestep_length¶
Gets the maximum_timestep_length of this AutoTimestepDefinition. # noqa: E501
- Returns
The maximum_timestep_length of this AutoTimestepDefinition. # noqa: E501
- Return type
- property minimum_timestep_length¶
Gets the minimum_timestep_length of this AutoTimestepDefinition. # noqa: E501
- Returns
The minimum_timestep_length of this AutoTimestepDefinition. # noqa: E501
- Return type
- openapi_types = {'maximum_residual': 'float', 'maximum_timestep_length': 'RestrictedDimensionalFunctionTime', 'minimum_timestep_length': 'DimensionalTime', 'retiming_event': 'OneOfAutoTimestepDefinitionRetimingEvent', 'simulation_interval': 'DimensionalTime', 'type': 'str'}¶
- property retiming_event¶
Gets the retiming_event of this AutoTimestepDefinition. # noqa: E501
- Returns
The retiming_event of this AutoTimestepDefinition. # noqa: E501
- Return type
OneOfAutoTimestepDefinitionRetimingEvent
- property simulation_interval¶
Gets the simulation_interval of this AutoTimestepDefinition. # noqa: E501
- Returns
The simulation_interval of this AutoTimestepDefinition. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutoTimestepDefinition. # noqa: E501
Schema name: AutoTimestepDefinition # noqa: E501
- Returns
The type of this AutoTimestepDefinition. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_layer_off module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_layer_off.AutomaticLayerOff(type='AUTOMATIC_LAYER_OFF', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticLayerOff. # noqa: E501
Schema name: AutomaticLayerOff # noqa: E501
- Returns
The type of this AutomaticLayerOff. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_layer_on module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_layer_on.AutomaticLayerOn(type='AUTOMATIC_LAYER_ON', number_of_layers=None, total_relative_thickness=None, layer_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'layer_type': 'layerType', 'number_of_layers': 'numberOfLayers', 'total_relative_thickness': 'totalRelativeThickness', 'type': 'type'}¶
- property layer_type¶
Gets the layer_type of this AutomaticLayerOn. # noqa: E501
- Returns
The layer_type of this AutomaticLayerOn. # noqa: E501
- Return type
OneOfAutomaticLayerOnLayerType
- property number_of_layers¶
Gets the number_of_layers of this AutomaticLayerOn. # noqa: E501
The <i>Number of layers</i> defines how many prismatic boundary layers should be created. 3 is default. # noqa: E501
- Returns
The number_of_layers of this AutomaticLayerOn. # noqa: E501
- Return type
int
- openapi_types = {'layer_type': 'OneOfAutomaticLayerOnLayerType', 'number_of_layers': 'int', 'total_relative_thickness': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total_relative_thickness¶
Gets the total_relative_thickness of this AutomaticLayerOn. # noqa: E501
It defines the thickness of all prismatic boundary layers combined in relation to the local element size.<img src=”/spec/resources/help/imgs/simmetrix-overall-layer-thickness.png” class=”helpPopupImage”/>Example 3-layer thickness of 40% (0.4) of the local mesh size. # noqa: E501
- Returns
The total_relative_thickness of this AutomaticLayerOn. # noqa: E501
- Return type
float
- property type¶
Gets the type of this AutomaticLayerOn. # noqa: E501
Schema name: AutomaticLayerOn # noqa: E501
- Returns
The type of this AutomaticLayerOn. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_mesh_grading module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_mesh_grading.AutomaticMeshGrading(type='AUTOMATIC', fineness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this AutomaticMeshGrading. # noqa: E501
<p>The <b><a href=’https://www.simscale.com/docs/simulation-setup/meshing/tet-dominant/#grading’ target=’_blank’>mesh grading</a></b> specifies how fine details of the geometry are resolved and also influences the quality of the resulting elements.</p><ul><li><p>If you select the <b>automatic</b> grading, you can specify how fine your mesh should be (ranging from <i>1 - very coarse</i> to <i>5 - very fine</i>) and all additional parameters will be set automatically.</li><li><p>For full control over the underlying parameters <i>number of segements per edge</i>, <i>number of segements per radius</i> and <i>growth rate</i> you can choose the <b>manual</b> mesh grading option.</p></li></ul><p><img src=”/spec/resources/help/imgs/mesh_grading_comparison.png” class=”helpPopupImage”/> The figure shows meshes for grading <i>1 - very coarse</i> (left) and <i>5 - very fine</i> (right).</p> # noqa: E501
- Returns
The fineness of this AutomaticMeshGrading. # noqa: E501
- Return type
str
- openapi_types = {'fineness': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticMeshGrading. # noqa: E501
Schema name: AutomaticMeshGrading # noqa: E501
- Returns
The type of this AutomaticMeshGrading. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_mesh_sizing module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_mesh_sizing.AutomaticMeshSizing(type='AUTOMATIC', fineness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this AutomaticMeshSizing. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/#local-mesh-refinements’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> # noqa: E501
- Returns
The fineness of this AutomaticMeshSizing. # noqa: E501
- Return type
str
- openapi_types = {'fineness': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticMeshSizing. # noqa: E501
Schema name: AutomaticMeshSizing # noqa: E501
- Returns
The type of this AutomaticMeshSizing. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_mesh_sizing_hex_dominant_snappy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_mesh_sizing_hex_dominant_snappy.AutomaticMeshSizingHexDominantSnappy(type='AUTOMATIC', fineness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this AutomaticMeshSizingHexDominantSnappy. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/#local-mesh-refinements’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> # noqa: E501
- Returns
The fineness of this AutomaticMeshSizingHexDominantSnappy. # noqa: E501
- Return type
str
- openapi_types = {'fineness': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticMeshSizingHexDominantSnappy. # noqa: E501
Schema name: AutomaticMeshSizingHexDominantSnappy # noqa: E501
- Returns
The type of this AutomaticMeshSizingHexDominantSnappy. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_mesh_sizing_simmetrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_mesh_sizing_simmetrix.AutomaticMeshSizingSimmetrix(type='AUTOMATIC_V9', fineness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this AutomaticMeshSizingSimmetrix. # noqa: E501
<p>Adjust the overall mesh sizing from coarse (value: 0) to fine (10).</p> # noqa: E501
- Returns
The fineness of this AutomaticMeshSizingSimmetrix. # noqa: E501
- Return type
float
- openapi_types = {'fineness': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticMeshSizingSimmetrix. # noqa: E501
Schema name: AutomaticMeshSizingSimmetrix # noqa: E501
- Returns
The type of this AutomaticMeshSizingSimmetrix. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_omega_dissipation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_omega_dissipation.AutomaticOmegaDissipation(type='AUTOMATIC_DISSIPATION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticOmegaDissipation. # noqa: E501
Schema name: AutomaticOmegaDissipation # noqa: E501
- Returns
The type of this AutomaticOmegaDissipation. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_reactualization module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_reactualization.AutomaticReactualization(type='AUTOMATIC', max_num_iterations=None, iteration_criterion=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iteration_criterion': 'iterationCriterion', 'max_num_iterations': 'maxNumIterations', 'type': 'type'}¶
- property iteration_criterion¶
Gets the iteration_criterion of this AutomaticReactualization. # noqa: E501
- Returns
The iteration_criterion of this AutomaticReactualization. # noqa: E501
- Return type
float
- property max_num_iterations¶
Gets the max_num_iterations of this AutomaticReactualization. # noqa: E501
- Returns
The max_num_iterations of this AutomaticReactualization. # noqa: E501
- Return type
int
- openapi_types = {'iteration_criterion': 'float', 'max_num_iterations': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticReactualization. # noqa: E501
Schema name: AutomaticReactualization # noqa: E501
- Returns
The type of this AutomaticReactualization. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_reference_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_reference_length.AutomaticReferenceLength(type='AUTOMATIC_REFERENCE_LENGTH', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticReferenceLength. # noqa: E501
Schema name: AutomaticReferenceLength # noqa: E501
- Returns
The type of this AutomaticReferenceLength. # noqa: E501
- Return type
str
simscale_sdk.models.automatic_simerics_mesh_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.automatic_simerics_mesh_settings.AutomaticSimericsMeshSettings(type='AUTOMATIC_SETTINGS', refinements=None, fineness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'refinements': 'refinements', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this AutomaticSimericsMeshSettings. # noqa: E501
<p>Adjust the overall mesh sizing from coarse (value: 0) to fine (10).</p> # noqa: E501
- Returns
The fineness of this AutomaticSimericsMeshSettings. # noqa: E501
- Return type
float
- openapi_types = {'fineness': 'float', 'refinements': 'list[RegionRefinementSimerics]', 'type': 'str'}¶
- property refinements¶
Gets the refinements of this AutomaticSimericsMeshSettings. # noqa: E501
- Returns
The refinements of this AutomaticSimericsMeshSettings. # noqa: E501
- Return type
list[RegionRefinementSimerics]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this AutomaticSimericsMeshSettings. # noqa: E501
Schema name: AutomaticSimericsMeshSettings # noqa: E501
- Returns
The type of this AutomaticSimericsMeshSettings. # noqa: E501
- Return type
str
simscale_sdk.models.average_fields_calculation_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.average_fields_calculation_result_control_item.AverageFieldsCalculationResultControlItem(type='AVERAGE_FIELDS_CALCULATION', name=None, field_selection=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_selection': 'fieldSelection', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property field_selection¶
Gets the field_selection of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Returns
The field_selection of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Return type
OneOfAverageFieldsCalculationResultControlItemFieldSelection
- property name¶
Gets the name of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Returns
The name of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'field_selection': 'OneOfAverageFieldsCalculationResultControlItemFieldSelection', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Returns
The topological_reference of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Return type
- property type¶
Gets the type of this AverageFieldsCalculationResultControlItem. # noqa: E501
Schema name: AverageFieldsCalculationResultControlItem # noqa: E501
- Returns
The type of this AverageFieldsCalculationResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.average_velocity_momentum_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.average_velocity_momentum_source.AverageVelocityMomentumSource(type='AVERAGE_VELOCITY', name=None, average_velocity=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_velocity': 'averageVelocity', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property average_velocity¶
Gets the average_velocity of this AverageVelocityMomentumSource. # noqa: E501
- Returns
The average_velocity of this AverageVelocityMomentumSource. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this AverageVelocityMomentumSource. # noqa: E501
- Returns
The geometry_primitive_uuids of this AverageVelocityMomentumSource. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this AverageVelocityMomentumSource. # noqa: E501
- Returns
The name of this AverageVelocityMomentumSource. # noqa: E501
- Return type
str
- openapi_types = {'average_velocity': 'DimensionalVectorSpeed', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this AverageVelocityMomentumSource. # noqa: E501
- Returns
The topological_reference of this AverageVelocityMomentumSource. # noqa: E501
- Return type
- property type¶
Gets the type of this AverageVelocityMomentumSource. # noqa: E501
Schema name: AverageVelocityMomentumSource # noqa: E501
- Returns
The type of this AverageVelocityMomentumSource. # noqa: E501
- Return type
str
simscale_sdk.models.backward_time_differentiation_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.backward_time_differentiation_scheme.BackwardTimeDifferentiationScheme(type='BACKWARD', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BackwardTimeDifferentiationScheme. # noqa: E501
Schema name: BackwardTimeDifferentiationScheme # noqa: E501
- Returns
The type of this BackwardTimeDifferentiationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.base_excitation_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.base_excitation_bc.BaseExcitationBC(type='BASE_EXCITATION', name=None, direction=None, acceleration=None, phase_angle=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property acceleration¶
Gets the acceleration of this BaseExcitationBC. # noqa: E501
- Returns
The acceleration of this BaseExcitationBC. # noqa: E501
- Return type
- attribute_map = {'acceleration': 'acceleration', 'direction': 'direction', 'name': 'name', 'phase_angle': 'phaseAngle', 'type': 'type'}¶
- property direction¶
Gets the direction of this BaseExcitationBC. # noqa: E501
- Returns
The direction of this BaseExcitationBC. # noqa: E501
- Return type
- property name¶
Gets the name of this BaseExcitationBC. # noqa: E501
- Returns
The name of this BaseExcitationBC. # noqa: E501
- Return type
str
- openapi_types = {'acceleration': 'DimensionalFunctionAcceleration', 'direction': 'DimensionalVectorDimensionless', 'name': 'str', 'phase_angle': 'DimensionalAngle', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this BaseExcitationBC. # noqa: E501
- Returns
The phase_angle of this BaseExcitationBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BaseExcitationBC. # noqa: E501
<p><b>Base excitation</b> boundary condition applies a uniform acceleration to all fixed surfaces in the model (zero displacement), e.g. faces assigned to the <i>Fixed support</i> boundary condition. Specify the direction vector, the acceleration magnitude and the delay in terms of a harmonic phase angle, from the load to the reference harmonic excitation.<a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/base-excitation/’ target=’_blank’>Learn more</a></p> Schema name: BaseExcitationBC # noqa: E501
- Returns
The type of this BaseExcitationBC. # noqa: E501
- Return type
str
simscale_sdk.models.basic_embedded_boundary_meshing module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.basic_embedded_boundary_meshing.BasicEmbeddedBoundaryMeshing(type='BASIC_MESH_SETTINGS', num_cells_per_direction=None, refinement_strategy=None, num_refinement_levels=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'num_cells_per_direction': 'numCellsPerDirection', 'num_refinement_levels': 'numRefinementLevels', 'refinement_strategy': 'refinementStrategy', 'type': 'type'}¶
- property num_cells_per_direction¶
Gets the num_cells_per_direction of this BasicEmbeddedBoundaryMeshing. # noqa: E501
- Returns
The num_cells_per_direction of this BasicEmbeddedBoundaryMeshing. # noqa: E501
- Return type
- property num_refinement_levels¶
Gets the num_refinement_levels of this BasicEmbeddedBoundaryMeshing. # noqa: E501
Number of refinement levels to refine in the vicinity of all CAD surfaces. # noqa: E501
- Returns
The num_refinement_levels of this BasicEmbeddedBoundaryMeshing. # noqa: E501
- Return type
int
- openapi_types = {'num_cells_per_direction': 'NumberOfCellsPerDirection', 'num_refinement_levels': 'int', 'refinement_strategy': 'OneOfBasicEmbeddedBoundaryMeshingRefinementStrategy', 'type': 'str'}¶
- property refinement_strategy¶
Gets the refinement_strategy of this BasicEmbeddedBoundaryMeshing. # noqa: E501
- Returns
The refinement_strategy of this BasicEmbeddedBoundaryMeshing. # noqa: E501
- Return type
OneOfBasicEmbeddedBoundaryMeshingRefinementStrategy
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BasicEmbeddedBoundaryMeshing. # noqa: E501
Schema name: BasicEmbeddedBoundaryMeshing # noqa: E501
- Returns
The type of this BasicEmbeddedBoundaryMeshing. # noqa: E501
- Return type
str
simscale_sdk.models.bathe_wilson module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.bathe_wilson.BatheWilson(type='JACOBI', prec_bathe=None, nmax_iter_bathe=None, prec_jacobi=None, max_iter_jacobi=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_iter_jacobi': 'maxIterJacobi', 'nmax_iter_bathe': 'nmaxIterBathe', 'prec_bathe': 'precBathe', 'prec_jacobi': 'precJacobi', 'type': 'type'}¶
- property max_iter_jacobi¶
Gets the max_iter_jacobi of this BatheWilson. # noqa: E501
- Returns
The max_iter_jacobi of this BatheWilson. # noqa: E501
- Return type
int
- property nmax_iter_bathe¶
Gets the nmax_iter_bathe of this BatheWilson. # noqa: E501
- Returns
The nmax_iter_bathe of this BatheWilson. # noqa: E501
- Return type
int
- openapi_types = {'max_iter_jacobi': 'int', 'nmax_iter_bathe': 'int', 'prec_bathe': 'float', 'prec_jacobi': 'float', 'type': 'str'}¶
- property prec_bathe¶
Gets the prec_bathe of this BatheWilson. # noqa: E501
- Returns
The prec_bathe of this BatheWilson. # noqa: E501
- Return type
float
- property prec_jacobi¶
Gets the prec_jacobi of this BatheWilson. # noqa: E501
- Returns
The prec_jacobi of this BatheWilson. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BatheWilson. # noqa: E501
Schema name: BatheWilson # noqa: E501
- Returns
The type of this BatheWilson. # noqa: E501
- Return type
str
simscale_sdk.models.bird_carreau_viscosity_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.bird_carreau_viscosity_model.BirdCarreauViscosityModel(type='BIRD_CARREAU', nu0=None, nu_inf=None, k=None, n=None, a=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property a¶
Gets the a of this BirdCarreauViscosityModel. # noqa: E501
- Returns
The a of this BirdCarreauViscosityModel. # noqa: E501
- Return type
- attribute_map = {'a': 'a', 'k': 'k', 'n': 'n', 'nu0': 'nu0', 'nu_inf': 'nuInf', 'type': 'type'}¶
- property k¶
Gets the k of this BirdCarreauViscosityModel. # noqa: E501
- Returns
The k of this BirdCarreauViscosityModel. # noqa: E501
- Return type
- property n¶
Gets the n of this BirdCarreauViscosityModel. # noqa: E501
- Returns
The n of this BirdCarreauViscosityModel. # noqa: E501
- Return type
- property nu0¶
Gets the nu0 of this BirdCarreauViscosityModel. # noqa: E501
- Returns
The nu0 of this BirdCarreauViscosityModel. # noqa: E501
- Return type
- property nu_inf¶
Gets the nu_inf of this BirdCarreauViscosityModel. # noqa: E501
- Returns
The nu_inf of this BirdCarreauViscosityModel. # noqa: E501
- Return type
- openapi_types = {'a': 'DimensionalDimensionless', 'k': 'DimensionalTime', 'n': 'DimensionalDimensionless', 'nu0': 'DimensionalKinematicViscosity', 'nu_inf': 'DimensionalKinematicViscosity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BirdCarreauViscosityModel. # noqa: E501
Choose between <a href=’https://www.simscale.com/docs/simulation-setup/materials/#newtonian-model’ target=’_blank’>Newtonian</a> and <a href=’https://www.simscale.com/docs/simulation-setup/materials/non-newtonian-models/’ target=’_blank’>Non-Newtonian</a> viscosity models. Schema name: BirdCarreauViscosityModel # noqa: E501
- Returns
The type of this BirdCarreauViscosityModel. # noqa: E501
- Return type
str
simscale_sdk.models.body_path module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.body_path.BodyPath(assembly=None, instance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property assembly¶
Gets the assembly of this BodyPath. # noqa: E501
- Returns
The assembly of this BodyPath. # noqa: E501
- Return type
str
- attribute_map = {'assembly': 'assembly', 'instance': 'instance'}¶
- property instance¶
Gets the instance of this BodyPath. # noqa: E501
- Returns
The instance of this BodyPath. # noqa: E501
- Return type
str
- openapi_types = {'assembly': 'str', 'instance': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.bolt_preload_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.bolt_preload_bc.BoltPreloadBC(type='BOLT_PRELOAD', name=None, preload=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'preload': 'preload', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this BoltPreloadBC. # noqa: E501
- Returns
The name of this BoltPreloadBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'preload': 'ForcePreload', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property preload¶
Gets the preload of this BoltPreloadBC. # noqa: E501
- Returns
The preload of this BoltPreloadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this BoltPreloadBC. # noqa: E501
- Returns
The topological_reference of this BoltPreloadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this BoltPreloadBC. # noqa: E501
<b>Bolt preload</b> boundary condition helps to model pre-stressed bolts in a CAD geometry for structural analysis. Enter a preload <i>force</i> to be assigned to cylindrical faces representing the shank of the bolt. <br><b>Note:</b><ul><li>These faces should be continuous and not be assigned to contact definitions.</li><li>Each bolt gets only one load, if multiple faces for the same bolt are assigned, they get ignored.</li><li>The applied load <b>does not get</b> distributed if multiple bolts are assigned.</li></ul> <img src=”/spec/resources/help/imgs/bolt_preload_help_text.png” class=”helpPopupImage”/> <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/bolt-preload/’ target=’_blank’>Learn more</a>. Schema name: BoltPreloadBC # noqa: E501
- Returns
The type of this BoltPreloadBC. # noqa: E501
- Return type
str
simscale_sdk.models.bonded_contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.bonded_contact.BondedContact(type='BONDED_CONTACT', name=None, enable_heat_transfer=None, position_tolerance=None, master_topological_reference=None, slave_topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'enable_heat_transfer': 'enableHeatTransfer', 'master_topological_reference': 'masterTopologicalReference', 'name': 'name', 'position_tolerance': 'positionTolerance', 'slave_topological_reference': 'slaveTopologicalReference', 'type': 'type'}¶
- property enable_heat_transfer¶
Gets the enable_heat_transfer of this BondedContact. # noqa: E501
- Returns
The enable_heat_transfer of this BondedContact. # noqa: E501
- Return type
str
- property master_topological_reference¶
Gets the master_topological_reference of this BondedContact. # noqa: E501
- Returns
The master_topological_reference of this BondedContact. # noqa: E501
- Return type
- property name¶
Gets the name of this BondedContact. # noqa: E501
- Returns
The name of this BondedContact. # noqa: E501
- Return type
str
- openapi_types = {'enable_heat_transfer': 'str', 'master_topological_reference': 'TopologicalReference', 'name': 'str', 'position_tolerance': 'OneOfBondedContactPositionTolerance', 'slave_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property position_tolerance¶
Gets the position_tolerance of this BondedContact. # noqa: E501
- Returns
The position_tolerance of this BondedContact. # noqa: E501
- Return type
OneOfBondedContactPositionTolerance
- property slave_topological_reference¶
Gets the slave_topological_reference of this BondedContact. # noqa: E501
- Returns
The slave_topological_reference of this BondedContact. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BondedContact. # noqa: E501
Schema name: BondedContact # noqa: E501
- Returns
The type of this BondedContact. # noqa: E501
- Return type
str
simscale_sdk.models.bounded_gauss_upwind_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.bounded_gauss_upwind_divergence_scheme.BoundedGaussUpwindDivergenceScheme(type='BOUNDED_GAUSS_UPWIND', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BoundedGaussUpwindDivergenceScheme. # noqa: E501
Schema name: BoundedGaussUpwindDivergenceScheme # noqa: E501
- Returns
The type of this BoundedGaussUpwindDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.bounding_box_layer_addition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.bounding_box_layer_addition.BoundingBoxLayerAddition(type='BOUNDING_BOX_LAYER_ADDITION', name=None, face=None, layers=None, expansion_ratio=None, min_thickness=None, final_thickness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'expansion_ratio': 'expansionRatio', 'face': 'face', 'final_thickness': 'finalThickness', 'layers': 'layers', 'min_thickness': 'minThickness', 'name': 'name', 'type': 'type'}¶
- property expansion_ratio¶
Gets the expansion_ratio of this BoundingBoxLayerAddition. # noqa: E501
<p>The <b>Expansion ratio</b> determines how the boundary layers grow in thickness from the wall to the internal mesh. The larger the ratio, the larger each cell layer will be in comparison to the neighbouring layer closer to the wall.</p><p><img src=”/spec/resources/help/imgs/shm_bl_expansion-ratio.png” class=”helpPopupImage”/> The figure shows a ratio of 1.3.</p> # noqa: E501
- Returns
The expansion_ratio of this BoundingBoxLayerAddition. # noqa: E501
- Return type
float
- property face¶
Gets the face of this BoundingBoxLayerAddition. # noqa: E501
This option selects the face of the bounding box on which layers will be added. A face is selected by its normal (denoted by the respective coordinate system axis) and its position (denoted by min or max). # noqa: E501
- Returns
The face of this BoundingBoxLayerAddition. # noqa: E501
- Return type
str
- property final_thickness¶
Gets the final_thickness of this BoundingBoxLayerAddition. # noqa: E501
- Returns
The final_thickness of this BoundingBoxLayerAddition. # noqa: E501
- Return type
- property layers¶
Gets the layers of this BoundingBoxLayerAddition. # noqa: E501
The number of <b>layers</b> defines how many boundary layers should be created. # noqa: E501
- Returns
The layers of this BoundingBoxLayerAddition. # noqa: E501
- Return type
int
- property min_thickness¶
Gets the min_thickness of this BoundingBoxLayerAddition. # noqa: E501
- Returns
The min_thickness of this BoundingBoxLayerAddition. # noqa: E501
- Return type
- property name¶
Gets the name of this BoundingBoxLayerAddition. # noqa: E501
- Returns
The name of this BoundingBoxLayerAddition. # noqa: E501
- Return type
str
- openapi_types = {'expansion_ratio': 'float', 'face': 'str', 'final_thickness': 'DimensionalLength', 'layers': 'int', 'min_thickness': 'DimensionalLength', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this BoundingBoxLayerAddition. # noqa: E501
This option enables layer refinement on the faces of the bounding box. This refinement is useful if the bounding box itself provides walls of the flow domain. It is often used for external aerodynamic cases where the floor is considered as a wall and hence the mesh should be refined with layers in the vicinity. Schema name: BoundingBoxLayerAddition # noqa: E501
- Returns
The type of this BoundingBoxLayerAddition. # noqa: E501
- Return type
str
simscale_sdk.models.box module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.box.Box(type='BOX', id=None, name=None, scale=None, translation=None, rotation_axis=None, rotation_angle=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'name': 'name', 'rotation_angle': 'rotationAngle', 'rotation_axis': 'rotationAxis', 'scale': 'scale', 'translation': 'translation', 'type': 'type'}¶
- property id¶
Gets the id of this Box. # noqa: E501
- Returns
The id of this Box. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Box. # noqa: E501
- Returns
The name of this Box. # noqa: E501
- Return type
str
- openapi_types = {'id': 'str', 'name': 'str', 'rotation_angle': 'DimensionalAngle', 'rotation_axis': 'DimensionalVectorLength', 'scale': 'DecimalVector', 'translation': 'DimensionalVectorLength', 'type': 'str'}¶
- property rotation_angle¶
Gets the rotation_angle of this Box. # noqa: E501
- Returns
The rotation_angle of this Box. # noqa: E501
- Return type
- property rotation_axis¶
Gets the rotation_axis of this Box. # noqa: E501
- Returns
The rotation_axis of this Box. # noqa: E501
- Return type
- property scale¶
Gets the scale of this Box. # noqa: E501
- Returns
The scale of this Box. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property translation¶
Gets the translation of this Box. # noqa: E501
- Returns
The translation of this Box. # noqa: E501
- Return type
- property type¶
Gets the type of this Box. # noqa: E501
Schema name: Box # noqa: E501
- Returns
The type of this Box. # noqa: E501
- Return type
str
simscale_sdk.models.buildings_of_interest module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.buildings_of_interest.BuildingsOfInterest(type='BUILDINGS_OF_INTEREST', topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'topological_reference': 'topologicalReference', 'type': 'type'}¶
- openapi_types = {'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this BuildingsOfInterest. # noqa: E501
- Returns
The topological_reference of this BuildingsOfInterest. # noqa: E501
- Return type
- property type¶
Gets the type of this BuildingsOfInterest. # noqa: E501
Schema name: BuildingsOfInterest # noqa: E501
- Returns
The type of this BuildingsOfInterest. # noqa: E501
- Return type
str
simscale_sdk.models.calculate_frequency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.calculate_frequency.CalculateFrequency(prec_shift=None, max_iter_shift=None, threshold_frequency=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_iter_shift': 'maxIterShift', 'prec_shift': 'precShift', 'threshold_frequency': 'thresholdFrequency'}¶
- property max_iter_shift¶
Gets the max_iter_shift of this CalculateFrequency. # noqa: E501
- Returns
The max_iter_shift of this CalculateFrequency. # noqa: E501
- Return type
int
- openapi_types = {'max_iter_shift': 'int', 'prec_shift': 'float', 'threshold_frequency': 'float'}¶
- property prec_shift¶
Gets the prec_shift of this CalculateFrequency. # noqa: E501
- Returns
The prec_shift of this CalculateFrequency. # noqa: E501
- Return type
float
- property threshold_frequency¶
Gets the threshold_frequency of this CalculateFrequency. # noqa: E501
- Returns
The threshold_frequency of this CalculateFrequency. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.calculated_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.calculated_dvbc.CalculatedDVBC(type='CALCULATED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CalculatedDVBC. # noqa: E501
Schema name: CalculatedDVBC # noqa: E501
- Returns
The type of this CalculatedDVBC. # noqa: E501
- Return type
str
simscale_sdk.models.calculated_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.calculated_evbc.CalculatedEVBC(type='CALCULATED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CalculatedEVBC. # noqa: E501
Schema name: CalculatedEVBC # noqa: E501
- Returns
The type of this CalculatedEVBC. # noqa: E501
- Return type
str
simscale_sdk.models.calculated_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.calculated_evcbc.CalculatedEVCBC(type='CALCULATED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CalculatedEVCBC. # noqa: E501
Schema name: CalculatedEVCBC # noqa: E501
- Returns
The type of this CalculatedEVCBC. # noqa: E501
- Return type
str
simscale_sdk.models.calculated_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.calculated_tdbc.CalculatedTDBC(type='CALCULATED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CalculatedTDBC. # noqa: E501
Schema name: CalculatedTDBC # noqa: E501
- Returns
The type of this CalculatedTDBC. # noqa: E501
- Return type
str
simscale_sdk.models.calculated_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.calculated_tdcbc.CalculatedTDCBC(type='CALCULATED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CalculatedTDCBC. # noqa: E501
Schema name: CalculatedTDCBC # noqa: E501
- Returns
The type of this CalculatedTDCBC. # noqa: E501
- Return type
str
simscale_sdk.models.cartesian_box module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cartesian_box.CartesianBox(type='CARTESIAN_BOX', id=None, name=None, min=None, max=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'max': 'max', 'min': 'min', 'name': 'name', 'type': 'type'}¶
- property id¶
Gets the id of this CartesianBox. # noqa: E501
- Returns
The id of this CartesianBox. # noqa: E501
- Return type
str
- property max¶
Gets the max of this CartesianBox. # noqa: E501
- Returns
The max of this CartesianBox. # noqa: E501
- Return type
- property min¶
Gets the min of this CartesianBox. # noqa: E501
- Returns
The min of this CartesianBox. # noqa: E501
- Return type
- property name¶
Gets the name of this CartesianBox. # noqa: E501
- Returns
The name of this CartesianBox. # noqa: E501
- Return type
str
- openapi_types = {'id': 'str', 'max': 'DimensionalVectorLength', 'min': 'DimensionalVectorLength', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CartesianBox. # noqa: E501
Schema name: CartesianBox # noqa: E501
- Returns
The type of this CartesianBox. # noqa: E501
- Return type
str
simscale_sdk.models.cartesian_orientation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cartesian_orientation.CartesianOrientation(type='CARTESIAN', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CartesianOrientation. # noqa: E501
Schema name: CartesianOrientation # noqa: E501
- Returns
The type of this CartesianOrientation. # noqa: E501
- Return type
str
simscale_sdk.models.castellated_mesh_controls module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.castellated_mesh_controls.CastellatedMeshControls(max_local_cells=None, max_global_cells=None, min_refinement_cells=None, max_load_unbalance=None, cells_between_levels=None, resolve_feature_angle=None, allow_free_standing_zone_faces=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property allow_free_standing_zone_faces¶
Gets the allow_free_standing_zone_faces of this CastellatedMeshControls. # noqa: E501
<p>Decide whether you want to allow zone faces that share the same owner and neighbour cell zone. Allowing this can lead to problem when zone faces are snapped to features. This parameter is ignored when no faceZones are present.</p> # noqa: E501
- Returns
The allow_free_standing_zone_faces of this CastellatedMeshControls. # noqa: E501
- Return type
bool
- attribute_map = {'allow_free_standing_zone_faces': 'allowFreeStandingZoneFaces', 'cells_between_levels': 'cellsBetweenLevels', 'max_global_cells': 'maxGlobalCells', 'max_load_unbalance': 'maxLoadUnbalance', 'max_local_cells': 'maxLocalCells', 'min_refinement_cells': 'minRefinementCells', 'resolve_feature_angle': 'resolveFeatureAngle'}¶
- property cells_between_levels¶
Gets the cells_between_levels of this CastellatedMeshControls. # noqa: E501
<p>This parameter specifies the number of layers of cells between different levels of refinement (see documentation).</p> # noqa: E501
- Returns
The cells_between_levels of this CastellatedMeshControls. # noqa: E501
- Return type
int
- property max_global_cells¶
Gets the max_global_cells of this CastellatedMeshControls. # noqa: E501
<p>Define the maximum possible number of cells summed upon all processors. Note that this is before the castellation step (see documentation, so the actual number of cells after castellation might be considerably less.</p> # noqa: E501
- Returns
The max_global_cells of this CastellatedMeshControls. # noqa: E501
- Return type
int
- property max_load_unbalance¶
Gets the max_load_unbalance of this CastellatedMeshControls. # noqa: E501
<p>Define a fraction indicating the maximum allowable load imbalance between processors working on this job. A value of 0 will force rebalancing for even a slight imbalance.</p> # noqa: E501
- Returns
The max_load_unbalance of this CastellatedMeshControls. # noqa: E501
- Return type
float
- property max_local_cells¶
Gets the max_local_cells of this CastellatedMeshControls. # noqa: E501
<p>Define the maximal number of cells per processor during refinement</p> # noqa: E501
- Returns
The max_local_cells of this CastellatedMeshControls. # noqa: E501
- Return type
int
- property min_refinement_cells¶
Gets the min_refinement_cells of this CastellatedMeshControls. # noqa: E501
<p>If in a refinement iteration the number of cells selected for refinement is under this value, the refinement stops. Provide a small value to ensure that all surfaces are refined to the proper level.</p> # noqa: E501
- Returns
The min_refinement_cells of this CastellatedMeshControls. # noqa: E501
- Return type
int
- openapi_types = {'allow_free_standing_zone_faces': 'bool', 'cells_between_levels': 'int', 'max_global_cells': 'int', 'max_load_unbalance': 'float', 'max_local_cells': 'int', 'min_refinement_cells': 'int', 'resolve_feature_angle': 'float'}¶
- property resolve_feature_angle¶
Gets the resolve_feature_angle of this CastellatedMeshControls. # noqa: E501
<p>Cells that face multiple intersections with an intersection angle greater than this angle will be refined to the max level. Use this parameter to resolve sharp features to the maximum level of surface refinement specified (see documentation).</p> # noqa: E501
- Returns
The resolve_feature_angle of this CastellatedMeshControls. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.cauchy_stress_tensor_field module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cauchy_stress_tensor_field.CauchyStressTensorField(type='CAUCHY_STRESS_TENSOR', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this CauchyStressTensorField. # noqa: E501
Choose a field component for which the data schould be extracted. # noqa: E501
- Returns
The component_selection of this CauchyStressTensorField. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CauchyStressTensorField. # noqa: E501
<p>Select the field which should have a limited de-/increase within one increment.</p> Schema name: CauchyStressTensorField # noqa: E501
- Returns
The type of this CauchyStressTensorField. # noqa: E501
- Return type
str
simscale_sdk.models.cauchy_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cauchy_stress_type.CauchyStressType(type='CAUCHY', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this CauchyStressType. # noqa: E501
- Returns
The component_selection of this CauchyStressType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CauchyStressType. # noqa: E501
Schema name: CauchyStressType # noqa: E501
- Returns
The type of this CauchyStressType. # noqa: E501
- Return type
str
simscale_sdk.models.cavitation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cavitation.Cavitation(vapor_molecular_weight=None, liquid_bulk_modulus=None, liquid_bulk_modulus_coefficient=None, liquid_reference_pressure=None, saturation_pressure=None, liquid_temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'liquid_bulk_modulus': 'liquidBulkModulus', 'liquid_bulk_modulus_coefficient': 'liquidBulkModulusCoefficient', 'liquid_reference_pressure': 'liquidReferencePressure', 'liquid_temperature': 'liquidTemperature', 'saturation_pressure': 'saturationPressure', 'vapor_molecular_weight': 'vaporMolecularWeight'}¶
- property liquid_bulk_modulus¶
Gets the liquid_bulk_modulus of this Cavitation. # noqa: E501
- Returns
The liquid_bulk_modulus of this Cavitation. # noqa: E501
- Return type
- property liquid_bulk_modulus_coefficient¶
Gets the liquid_bulk_modulus_coefficient of this Cavitation. # noqa: E501
The <b>liquid bulk modulus coefficient</b> <i>B<sub>1</sub></i> accounts for a linear rate of change in the liquid bulk modulus with respect to pressure such that <i>B = B<sub>0</sub> + B<sub>1</sub> (P - P<sub>ref</sub>)</i>, where <i>B<sub>0</sub></i> is the constant liquid bulk modulus. Typically only applicable in cases where pressure differences exceed 100 bar, otherwise a zero value should be specified. # noqa: E501
- Returns
The liquid_bulk_modulus_coefficient of this Cavitation. # noqa: E501
- Return type
float
- property liquid_reference_pressure¶
Gets the liquid_reference_pressure of this Cavitation. # noqa: E501
- Returns
The liquid_reference_pressure of this Cavitation. # noqa: E501
- Return type
- property liquid_temperature¶
Gets the liquid_temperature of this Cavitation. # noqa: E501
- Returns
The liquid_temperature of this Cavitation. # noqa: E501
- Return type
- openapi_types = {'liquid_bulk_modulus': 'DimensionalPressure', 'liquid_bulk_modulus_coefficient': 'float', 'liquid_reference_pressure': 'DimensionalPressure', 'liquid_temperature': 'DimensionalTemperature', 'saturation_pressure': 'DimensionalPressure', 'vapor_molecular_weight': 'DimensionalMolarMass'}¶
- property saturation_pressure¶
Gets the saturation_pressure of this Cavitation. # noqa: E501
- Returns
The saturation_pressure of this Cavitation. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vapor_molecular_weight¶
Gets the vapor_molecular_weight of this Cavitation. # noqa: E501
- Returns
The vapor_molecular_weight of this Cavitation. # noqa: E501
- Return type
simscale_sdk.models.cell_count module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cell_count.CellCount(type=None, value=None, interval_min=None, interval_max=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'interval_max': 'intervalMax', 'interval_min': 'intervalMin', 'type': 'type', 'value': 'value'}¶
- property interval_max¶
Gets the interval_max of this CellCount. # noqa: E501
- Returns
The interval_max of this CellCount. # noqa: E501
- Return type
int
- property interval_min¶
Gets the interval_min of this CellCount. # noqa: E501
- Returns
The interval_min of this CellCount. # noqa: E501
- Return type
int
- openapi_types = {'interval_max': 'int', 'interval_min': 'int', 'type': 'str', 'value': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CellCount. # noqa: E501
- Returns
The type of this CellCount. # noqa: E501
- Return type
str
- property value¶
Gets the value of this CellCount. # noqa: E501
- Returns
The value of this CellCount. # noqa: E501
- Return type
int
simscale_sdk.models.celllimited_gauss_linear_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.celllimited_gauss_linear_gradient_scheme.CelllimitedGaussLinearGradientScheme(type='CELLLIMITED_GAUSS_LINEAR', limiter_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'limiter_coefficient': 'limiterCoefficient', 'type': 'type'}¶
- property limiter_coefficient¶
Gets the limiter_coefficient of this CelllimitedGaussLinearGradientScheme. # noqa: E501
This property defines a limiter coefficient for the scheme. 1 ensures boundedness while 0 applies no limiting. # noqa: E501
- Returns
The limiter_coefficient of this CelllimitedGaussLinearGradientScheme. # noqa: E501
- Return type
float
- openapi_types = {'limiter_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CelllimitedGaussLinearGradientScheme. # noqa: E501
Schema name: CelllimitedGaussLinearGradientScheme # noqa: E501
- Returns
The type of this CelllimitedGaussLinearGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.celllimited_least_squares_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.celllimited_least_squares_gradient_scheme.CelllimitedLeastSquaresGradientScheme(type='CELLLIMITED_LEASTSQUARES', limiter_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'limiter_coefficient': 'limiterCoefficient', 'type': 'type'}¶
- property limiter_coefficient¶
Gets the limiter_coefficient of this CelllimitedLeastSquaresGradientScheme. # noqa: E501
This property defines a limiter coefficient for the scheme. 1 ensures boundedness while 0 applies no limiting. # noqa: E501
- Returns
The limiter_coefficient of this CelllimitedLeastSquaresGradientScheme. # noqa: E501
- Return type
float
- openapi_types = {'limiter_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CelllimitedLeastSquaresGradientScheme. # noqa: E501
Schema name: CelllimitedLeastSquaresGradientScheme # noqa: E501
- Returns
The type of this CelllimitedLeastSquaresGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.central_diff_time_integration_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.central_diff_time_integration_scheme.CentralDiffTimeIntegrationScheme(type='CENTRAL_DIFF', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CentralDiffTimeIntegrationScheme. # noqa: E501
Schema name: CentralDiffTimeIntegrationScheme # noqa: E501
- Returns
The type of this CentralDiffTimeIntegrationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.centrifugal_force_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.centrifugal_force_bc.CentrifugalForceBC(type='CENTRIFUGAL_FORCE', name=None, rotation=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'rotation': 'rotation', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this CentrifugalForceBC. # noqa: E501
- Returns
The name of this CentrifugalForceBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'rotation': 'AngularRotation', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property rotation¶
Gets the rotation of this CentrifugalForceBC. # noqa: E501
- Returns
The rotation of this CentrifugalForceBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this CentrifugalForceBC. # noqa: E501
- Returns
The topological_reference of this CentrifugalForceBC. # noqa: E501
- Return type
- property type¶
Gets the type of this CentrifugalForceBC. # noqa: E501
<p>This is a <b>centrifugal force</b> boundary condition. Each volume element of the selection is loaded with a centrifugal force which is calculated depending on its volume, the density of the assigned material, its distance from the axis of rotation and the defined rotational velocity.<br /><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/centrifugal-force/’ target=’_blank’>Learn more</a>.</p> Schema name: CentrifugalForceBC # noqa: E501
- Returns
The type of this CentrifugalForceBC. # noqa: E501
- Return type
str
simscale_sdk.models.check_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.check_response.CheckResponse(severity=None, entries=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'entries': 'entries', 'severity': 'severity'}¶
- property entries¶
Gets the entries of this CheckResponse. # noqa: E501
- Returns
The entries of this CheckResponse. # noqa: E501
- Return type
list[LogEntry]
- openapi_types = {'entries': 'list[LogEntry]', 'severity': 'LogSeverity'}¶
- property severity¶
Gets the severity of this CheckResponse. # noqa: E501
- Returns
The severity of this CheckResponse. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.chestnut module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.chestnut.Chestnut(type='CHESTNUT', average_tree_height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_tree_height': 'averageTreeHeight', 'type': 'type'}¶
- property average_tree_height¶
Gets the average_tree_height of this Chestnut. # noqa: E501
- Returns
The average_tree_height of this Chestnut. # noqa: E501
- Return type
- openapi_types = {'average_tree_height': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Chestnut. # noqa: E501
Schema name: Chestnut # noqa: E501
- Returns
The type of this Chestnut. # noqa: E501
- Return type
str
simscale_sdk.models.circular_hole_shape module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.circular_hole_shape.CircularHoleShape(type='CIRCULAR', average_hole_diameter=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_hole_diameter': 'averageHoleDiameter', 'type': 'type'}¶
- property average_hole_diameter¶
Gets the average_hole_diameter of this CircularHoleShape. # noqa: E501
- Returns
The average_hole_diameter of this CircularHoleShape. # noqa: E501
- Return type
- openapi_types = {'average_hole_diameter': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CircularHoleShape. # noqa: E501
Circular holes in the perforated plate. Schema name: CircularHoleShape # noqa: E501
- Returns
The type of this CircularHoleShape. # noqa: E501
- Return type
str
simscale_sdk.models.clock_time_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.clock_time_write_control.ClockTimeWriteControl(type='CLOCK_TIME', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'DimensionalTime'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ClockTimeWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: ClockTimeWriteControl # noqa: E501
- Returns
The type of this ClockTimeWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this ClockTimeWriteControl. # noqa: E501
- Returns
The write_interval of this ClockTimeWriteControl. # noqa: E501
- Return type
simscale_sdk.models.coarse_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.coarse_resolution.CoarseResolution(type='COARSE_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CoarseResolution. # noqa: E501
Output will be written every 8 time steps. Schema name: CoarseResolution # noqa: E501
- Returns
The type of this CoarseResolution. # noqa: E501
- Return type
str
simscale_sdk.models.collection_links module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_links.CollectionLinks(first=None, prev=None, _self=None, next=None, last=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_self': 'self', 'first': 'first', 'last': 'last', 'next': 'next', 'prev': 'prev'}¶
- property first¶
Gets the first of this CollectionLinks. # noqa: E501
- Returns
The first of this CollectionLinks. # noqa: E501
- Return type
- property last¶
Gets the last of this CollectionLinks. # noqa: E501
- Returns
The last of this CollectionLinks. # noqa: E501
- Return type
- property next¶
Gets the next of this CollectionLinks. # noqa: E501
- Returns
The next of this CollectionLinks. # noqa: E501
- Return type
- openapi_types = {'_self': 'CollectionLinksSelf', 'first': 'CollectionLinksFirst', 'last': 'CollectionLinksLast', 'next': 'CollectionLinksNext', 'prev': 'CollectionLinksPrev'}¶
- property prev¶
Gets the prev of this CollectionLinks. # noqa: E501
- Returns
The prev of this CollectionLinks. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.collection_links_first module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_links_first.CollectionLinksFirst(href=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'href': 'href'}¶
- property href¶
Gets the href of this CollectionLinksFirst. # noqa: E501
First page of the collection. # noqa: E501
- Returns
The href of this CollectionLinksFirst. # noqa: E501
- Return type
str
- openapi_types = {'href': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.collection_links_last module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_links_last.CollectionLinksLast(href=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'href': 'href'}¶
- property href¶
Gets the href of this CollectionLinksLast. # noqa: E501
Last page of the collection. # noqa: E501
- Returns
The href of this CollectionLinksLast. # noqa: E501
- Return type
str
- openapi_types = {'href': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.collection_links_next module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_links_next.CollectionLinksNext(href=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'href': 'href'}¶
- property href¶
Gets the href of this CollectionLinksNext. # noqa: E501
Next page in the collection. # noqa: E501
- Returns
The href of this CollectionLinksNext. # noqa: E501
- Return type
str
- openapi_types = {'href': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.collection_links_prev module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_links_prev.CollectionLinksPrev(href=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'href': 'href'}¶
- property href¶
Gets the href of this CollectionLinksPrev. # noqa: E501
Previous page in the collection. # noqa: E501
- Returns
The href of this CollectionLinksPrev. # noqa: E501
- Return type
str
- openapi_types = {'href': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.collection_links_self module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_links_self.CollectionLinksSelf(href=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'href': 'href'}¶
- property href¶
Gets the href of this CollectionLinksSelf. # noqa: E501
Current page of the collection. # noqa: E501
- Returns
The href of this CollectionLinksSelf. # noqa: E501
- Return type
str
- openapi_types = {'href': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.collection_meta module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collection_meta.CollectionMeta(total=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'total': 'total'}¶
- openapi_types = {'total': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total¶
Gets the total of this CollectionMeta. # noqa: E501
Total number of resources in the collection. # noqa: E501
- Returns
The total of this CollectionMeta. # noqa: E501
- Return type
int
simscale_sdk.models.collision_retiming_event module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.collision_retiming_event.CollisionRetimingEvent(type='COLLISION', timestep_calculation_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'timestep_calculation_type': 'timestepCalculationType', 'type': 'type'}¶
- openapi_types = {'timestep_calculation_type': 'ManualTimestepCalculationType', 'type': 'str'}¶
- property timestep_calculation_type¶
Gets the timestep_calculation_type of this CollisionRetimingEvent. # noqa: E501
- Returns
The timestep_calculation_type of this CollisionRetimingEvent. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CollisionRetimingEvent. # noqa: E501
<p>Select the event for the time step adaptation. Currently there are four different events possible that trigger a time step adaptation:</p><ul><li><p><b>Error</b>: This is the case of a general error like for example non-convergence or singular matrix errors.</p></ul><ul><li><p><b>Collision</b>: This event is triggered if in a computation with physical contact a contact state change from open to closed is noticed. This time step adaptation is especially useful in dynamics to reduce the effect of artificial oscillations due to inexact collision detection.</p></ul><ul><li><p><b>Field Change</b>: The user can define the maximum delta that a field is allowed to change within one time step, if the defined threshold is exceeded the time step is adapted. This time stepping criteria is especially useful to capture material nonlinearitier more exact.</p></ul><ul><li><p><b>Non-monotonous residual</b>: This event is triggered if the residual has not been reduced within three iterations . This criteria is mostly used to reduce runtime by detecting diverging time steps before reaching the maximum number of allowed newton iterations.</p></ul> Schema name: CollisionRetimingEvent # noqa: E501
- Returns
The type of this CollisionRetimingEvent. # noqa: E501
- Return type
str
simscale_sdk.models.color module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.color.Color(r=None, g=None, b=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'b': 'b', 'g': 'g', 'r': 'r'}¶
- property b¶
Gets the b of this Color. # noqa: E501
- Returns
The b of this Color. # noqa: E501
- Return type
float
- property g¶
Gets the g of this Color. # noqa: E501
- Returns
The g of this Color. # noqa: E501
- Return type
float
- openapi_types = {'b': 'float', 'g': 'float', 'r': 'float'}¶
- property r¶
Gets the r of this Color. # noqa: E501
- Returns
The r of this Color. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.comets_visualization_style module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.comets_visualization_style.CometsVisualizationStyle(representation='COMETS', num_pulses=15, relative_comet_length=1e-05, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'num_pulses': 'numPulses', 'relative_comet_length': 'relativeCometLength', 'representation': 'representation'}¶
- property num_pulses¶
Gets the num_pulses of this CometsVisualizationStyle. # noqa: E501
This value specifies how many pulses there should be in the model. # noqa: E501
- Returns
The num_pulses of this CometsVisualizationStyle. # noqa: E501
- Return type
int
- openapi_types = {'num_pulses': 'int', 'relative_comet_length': 'float', 'representation': 'str'}¶
- property relative_comet_length¶
Gets the relative_comet_length of this CometsVisualizationStyle. # noqa: E501
The length of the tail of the comets. It is specified in time and is a fraction of the global total time range for all particles in this particle trace. For example, if the total trace time is 2, and the relativeCometLength is 0.01, then the length of the tail will be 0.02. # noqa: E501
- Returns
The relative_comet_length of this CometsVisualizationStyle. # noqa: E501
- Return type
float
- property representation¶
Gets the representation of this CometsVisualizationStyle. # noqa: E501
The representation to use for particle traces. # noqa: E501
- Returns
The representation of this CometsVisualizationStyle. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.component_vector_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.component_vector_function.ComponentVectorFunction(type='COMPONENT', x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'type': 'str', 'x': 'OneOfComponentVectorFunctionX', 'y': 'OneOfComponentVectorFunctionY', 'z': 'OneOfComponentVectorFunctionZ'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ComponentVectorFunction. # noqa: E501
Schema name: ComponentVectorFunction # noqa: E501
- Returns
The type of this ComponentVectorFunction. # noqa: E501
- Return type
str
- property x¶
Gets the x of this ComponentVectorFunction. # noqa: E501
- Returns
The x of this ComponentVectorFunction. # noqa: E501
- Return type
OneOfComponentVectorFunctionX
- property y¶
Gets the y of this ComponentVectorFunction. # noqa: E501
- Returns
The y of this ComponentVectorFunction. # noqa: E501
- Return type
OneOfComponentVectorFunctionY
- property z¶
Gets the z of this ComponentVectorFunction. # noqa: E501
- Returns
The z of this ComponentVectorFunction. # noqa: E501
- Return type
OneOfComponentVectorFunctionZ
simscale_sdk.models.compressible module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.compressible.Compressible(type='COMPRESSIBLE', turbulence_model=None, time_dependency=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this Compressible. # noqa: E501
- Returns
The advanced_concepts of this Compressible. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this Compressible. # noqa: E501
- Returns
The boundary_conditions of this Compressible. # noqa: E501
- Return type
list[OneOfCompressibleBoundaryConditions]
- property initial_conditions¶
Gets the initial_conditions of this Compressible. # noqa: E501
- Returns
The initial_conditions of this Compressible. # noqa: E501
- Return type
- property materials¶
Gets the materials of this Compressible. # noqa: E501
- Returns
The materials of this Compressible. # noqa: E501
- Return type
- property model¶
Gets the model of this Compressible. # noqa: E501
- Returns
The model of this Compressible. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this Compressible. # noqa: E501
- Returns
The numerics of this Compressible. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfCompressibleBoundaryConditions]', 'initial_conditions': 'FluidInitialConditions', 'materials': 'CompressibleFluidMaterials', 'model': 'FluidModel', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'time_dependency': 'OneOfCompressibleTimeDependency', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this Compressible. # noqa: E501
- Returns
The result_control of this Compressible. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this Compressible. # noqa: E501
- Returns
The simulation_control of this Compressible. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this Compressible. # noqa: E501
- Returns
The time_dependency of this Compressible. # noqa: E501
- Return type
OneOfCompressibleTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this Compressible. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this Compressible. # noqa: E501
- Return type
str
- property type¶
Gets the type of this Compressible. # noqa: E501
Schema name: Compressible # noqa: E501
- Returns
The type of this Compressible. # noqa: E501
- Return type
str
simscale_sdk.models.compressible_fluid_materials module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.compressible_fluid_materials.CompressibleFluidMaterials(fluids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fluids': 'fluids'}¶
- property fluids¶
Gets the fluids of this CompressibleFluidMaterials. # noqa: E501
- Returns
The fluids of this CompressibleFluidMaterials. # noqa: E501
- Return type
- openapi_types = {'fluids': 'list[FluidCompressibleMaterial]'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.compute_resource module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.compute_resource.ComputeResource(type=None, value=None, interval_min=None, interval_max=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'interval_max': 'intervalMax', 'interval_min': 'intervalMin', 'type': 'type', 'value': 'value'}¶
- property interval_max¶
Gets the interval_max of this ComputeResource. # noqa: E501
- Returns
The interval_max of this ComputeResource. # noqa: E501
- Return type
float
- property interval_min¶
Gets the interval_min of this ComputeResource. # noqa: E501
- Returns
The interval_min of this ComputeResource. # noqa: E501
- Return type
float
- openapi_types = {'interval_max': 'float', 'interval_min': 'float', 'type': 'ComputeResourceType', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ComputeResource. # noqa: E501
- Returns
The type of this ComputeResource. # noqa: E501
- Return type
- property value¶
Gets the value of this ComputeResource. # noqa: E501
- Returns
The value of this ComputeResource. # noqa: E501
- Return type
float
simscale_sdk.models.compute_resource_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.compute_resource_type.ComputeResourceType(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- CPU_HOURS = 'CPU_HOURS'¶
- GPU_HOURS = 'GPU_HOURS'¶
- allowable_values = ['CPU_HOURS', 'GPU_HOURS']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.computing_core module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.computing_core.ComputingCore(num_of_processors=None, num_of_computing_processors=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'num_of_computing_processors': 'numOfComputingProcessors', 'num_of_processors': 'numOfProcessors'}¶
- property num_of_computing_processors¶
Gets the num_of_computing_processors of this ComputingCore. # noqa: E501
<p>Set the number of processors which shall be used for the parallel computation.</p> # noqa: E501
- Returns
The num_of_computing_processors of this ComputingCore. # noqa: E501
- Return type
int
- property num_of_processors¶
Gets the num_of_processors of this ComputingCore. # noqa: E501
<p>Selecting more processor cores will speed up the simulation process. Choosing a smaller computation instance will save core hours. <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control-fluid/#number-of-processors’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The num_of_processors of this ComputingCore. # noqa: E501
- Return type
int
- openapi_types = {'num_of_computing_processors': 'int', 'num_of_processors': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.conductivity_thickness_pair module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.conductivity_thickness_pair.ConductivityThicknessPair(thermal_conductivity=None, layer_thickness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'layer_thickness': 'layerThickness', 'thermal_conductivity': 'thermalConductivity'}¶
- property layer_thickness¶
Gets the layer_thickness of this ConductivityThicknessPair. # noqa: E501
- Returns
The layer_thickness of this ConductivityThicknessPair. # noqa: E501
- Return type
- openapi_types = {'layer_thickness': 'DimensionalLength', 'thermal_conductivity': 'DimensionalThermalConductivity'}¶
- property thermal_conductivity¶
Gets the thermal_conductivity of this ConductivityThicknessPair. # noqa: E501
- Returns
The thermal_conductivity of this ConductivityThicknessPair. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.conjugate_heat_transfer module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.conjugate_heat_transfer.ConjugateHeatTransfer(type='CONJUGATE_HEAT_TRANSFER', turbulence_model=None, time_dependency=None, enable_radiation=None, connection_groups=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, contact_handling_mode=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this ConjugateHeatTransfer. # noqa: E501
- Returns
The advanced_concepts of this ConjugateHeatTransfer. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'contact_handling_mode': 'contactHandlingMode', 'enable_radiation': 'enableRadiation', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this ConjugateHeatTransfer. # noqa: E501
- Returns
The boundary_conditions of this ConjugateHeatTransfer. # noqa: E501
- Return type
list[OneOfConjugateHeatTransferBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this ConjugateHeatTransfer. # noqa: E501
- Returns
The connection_groups of this ConjugateHeatTransfer. # noqa: E501
- Return type
list[FluidInterface]
- property contact_handling_mode¶
Gets the contact_handling_mode of this ConjugateHeatTransfer. # noqa: E501
- Returns
The contact_handling_mode of this ConjugateHeatTransfer. # noqa: E501
- Return type
str
- property enable_radiation¶
Gets the enable_radiation of this ConjugateHeatTransfer. # noqa: E501
Heat transfer through radiation takes place in the form of electromagnetic waves and it can be calculated in the simulation. This phenomenon becomes more important when the temperatures involved in the simulation are large. <a href=’https://www.simscale.com/docs/analysis-types/convective-heat-transfer-analysis/radiation/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_radiation of this ConjugateHeatTransfer. # noqa: E501
- Return type
bool
- property initial_conditions¶
Gets the initial_conditions of this ConjugateHeatTransfer. # noqa: E501
- Returns
The initial_conditions of this ConjugateHeatTransfer. # noqa: E501
- Return type
- property materials¶
Gets the materials of this ConjugateHeatTransfer. # noqa: E501
- Returns
The materials of this ConjugateHeatTransfer. # noqa: E501
- Return type
- property model¶
Gets the model of this ConjugateHeatTransfer. # noqa: E501
- Returns
The model of this ConjugateHeatTransfer. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this ConjugateHeatTransfer. # noqa: E501
- Returns
The numerics of this ConjugateHeatTransfer. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfConjugateHeatTransferBoundaryConditions]', 'connection_groups': 'list[FluidInterface]', 'contact_handling_mode': 'str', 'enable_radiation': 'bool', 'initial_conditions': 'FluidInitialConditions', 'materials': 'ConjugateHeatTransferMaterials', 'model': 'FluidModel', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'time_dependency': 'OneOfConjugateHeatTransferTimeDependency', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this ConjugateHeatTransfer. # noqa: E501
- Returns
The result_control of this ConjugateHeatTransfer. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this ConjugateHeatTransfer. # noqa: E501
- Returns
The simulation_control of this ConjugateHeatTransfer. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this ConjugateHeatTransfer. # noqa: E501
- Returns
The time_dependency of this ConjugateHeatTransfer. # noqa: E501
- Return type
OneOfConjugateHeatTransferTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this ConjugateHeatTransfer. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this ConjugateHeatTransfer. # noqa: E501
- Return type
str
- property type¶
Gets the type of this ConjugateHeatTransfer. # noqa: E501
Schema name: ConjugateHeatTransfer # noqa: E501
- Returns
The type of this ConjugateHeatTransfer. # noqa: E501
- Return type
str
simscale_sdk.models.conjugate_heat_transfer_materials module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.conjugate_heat_transfer_materials.ConjugateHeatTransferMaterials(fluids=None, solids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fluids': 'fluids', 'solids': 'solids'}¶
- property fluids¶
Gets the fluids of this ConjugateHeatTransferMaterials. # noqa: E501
- Returns
The fluids of this ConjugateHeatTransferMaterials. # noqa: E501
- Return type
- openapi_types = {'fluids': 'list[FluidCompressibleMaterial]', 'solids': 'list[SolidCompressibleMaterial]'}¶
- property solids¶
Gets the solids of this ConjugateHeatTransferMaterials. # noqa: E501
- Returns
The solids of this ConjugateHeatTransferMaterials. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.connection_settings_v36 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.connection_settings_v36.ConnectionSettingsV36(nonlinearity_resolution=None, friction=None, contact_non_linearity_resolution=None, convergence_stabilization=None, contact_smoothing=None, stop_if_interpenetration=None, verify_norms=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_non_linearity_resolution': 'contactNonLinearityResolution', 'contact_smoothing': 'contactSmoothing', 'convergence_stabilization': 'convergenceStabilization', 'friction': 'friction', 'nonlinearity_resolution': 'nonlinearityResolution', 'stop_if_interpenetration': 'stopIfInterpenetration', 'verify_norms': 'verifyNorms'}¶
- property contact_non_linearity_resolution¶
Gets the contact_non_linearity_resolution of this ConnectionSettingsV36. # noqa: E501
- Returns
The contact_non_linearity_resolution of this ConnectionSettingsV36. # noqa: E501
- Return type
OneOfConnectionSettingsV36ContactNonLinearityResolution
- property contact_smoothing¶
Gets the contact_smoothing of this ConnectionSettingsV36. # noqa: E501
- Returns
The contact_smoothing of this ConnectionSettingsV36. # noqa: E501
- Return type
bool
- property convergence_stabilization¶
Gets the convergence_stabilization of this ConnectionSettingsV36. # noqa: E501
- Returns
The convergence_stabilization of this ConnectionSettingsV36. # noqa: E501
- Return type
bool
- property friction¶
Gets the friction of this ConnectionSettingsV36. # noqa: E501
- Returns
The friction of this ConnectionSettingsV36. # noqa: E501
- Return type
OneOfConnectionSettingsV36Friction
- property nonlinearity_resolution¶
Gets the nonlinearity_resolution of this ConnectionSettingsV36. # noqa: E501
- Returns
The nonlinearity_resolution of this ConnectionSettingsV36. # noqa: E501
- Return type
OneOfConnectionSettingsV36NonlinearityResolution
- openapi_types = {'contact_non_linearity_resolution': 'OneOfConnectionSettingsV36ContactNonLinearityResolution', 'contact_smoothing': 'bool', 'convergence_stabilization': 'bool', 'friction': 'OneOfConnectionSettingsV36Friction', 'nonlinearity_resolution': 'OneOfConnectionSettingsV36NonlinearityResolution', 'stop_if_interpenetration': 'bool', 'verify_norms': 'bool'}¶
- property stop_if_interpenetration¶
Gets the stop_if_interpenetration of this ConnectionSettingsV36. # noqa: E501
- Returns
The stop_if_interpenetration of this ConnectionSettingsV36. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property verify_norms¶
Gets the verify_norms of this ConnectionSettingsV36. # noqa: E501
- Returns
The verify_norms of this ConnectionSettingsV36. # noqa: E501
- Return type
bool
simscale_sdk.models.const_an_iso_transport module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.const_an_iso_transport.ConstAnIsoTransport(type='CONST_AN_ISO', conductivity=None, orientation=None, thermo=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'conductivity': 'conductivity', 'orientation': 'orientation', 'thermo': 'thermo', 'type': 'type'}¶
- property conductivity¶
Gets the conductivity of this ConstAnIsoTransport. # noqa: E501
- Returns
The conductivity of this ConstAnIsoTransport. # noqa: E501
- Return type
- openapi_types = {'conductivity': 'OrthotropicConductivity', 'orientation': 'OneOfConstAnIsoTransportOrientation', 'thermo': 'HConstThermo', 'type': 'str'}¶
- property orientation¶
Gets the orientation of this ConstAnIsoTransport. # noqa: E501
- Returns
The orientation of this ConstAnIsoTransport. # noqa: E501
- Return type
OneOfConstAnIsoTransportOrientation
- property thermo¶
Gets the thermo of this ConstAnIsoTransport. # noqa: E501
- Returns
The thermo of this ConstAnIsoTransport. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ConstAnIsoTransport. # noqa: E501
<p>The thermal conductivity of a material is a measure of its ability to conduct heat.<ul><li><strong>Isotropic</strong>: the thermal conductivity κ is the same in all directions.</li><li><strong>Orthotropic</strong>: the thermal conductivity is unique and independent in three orthogonal directions. It is defined by κ<sub>x</sub>, κ<sub>y</sub>, and κ<sub>z</sub>.</li><li><strong>Cross-plane orthotropic</strong>: it is defined by an <em>in-plane</em> conductivity, which is an isotropic conductivity on a given plane, and a <em>cross-plane<strong> </strong></em>conductivity, which acts in the direction normal to the aforementioned plane.</li></ul></p> Schema name: ConstAnIsoTransport # noqa: E501
- Returns
The type of this ConstAnIsoTransport. # noqa: E501
- Return type
str
simscale_sdk.models.const_cross_plane_orthotropic_transport module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.const_cross_plane_orthotropic_transport.ConstCrossPlaneOrthotropicTransport(type='CONST_CROSS_PLANE_ORTHO', conductivity=None, orientation=None, thermo=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'conductivity': 'conductivity', 'orientation': 'orientation', 'thermo': 'thermo', 'type': 'type'}¶
- property conductivity¶
Gets the conductivity of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Returns
The conductivity of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Return type
- openapi_types = {'conductivity': 'CrossPlaneOrthotropicConductivity', 'orientation': 'OneOfConstCrossPlaneOrthotropicTransportOrientation', 'thermo': 'HConstThermo', 'type': 'str'}¶
- property orientation¶
Gets the orientation of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Returns
The orientation of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Return type
OneOfConstCrossPlaneOrthotropicTransportOrientation
- property thermo¶
Gets the thermo of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Returns
The thermo of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
<p>The thermal conductivity of a material is a measure of its ability to conduct heat.<ul><li><strong>Isotropic</strong>: the thermal conductivity κ is the same in all directions.</li><li><strong>Orthotropic</strong>: the thermal conductivity is unique and independent in three orthogonal directions. It is defined by κ<sub>x</sub>, κ<sub>y</sub>, and κ<sub>z</sub>.</li><li><strong>Cross-plane orthotropic</strong>: it is defined by an <em>in-plane</em> conductivity, which is an isotropic conductivity on a given plane, and a <em>cross-plane<strong> </strong></em>conductivity, which acts in the direction normal to the aforementioned plane.</li></ul></p> Schema name: ConstCrossPlaneOrthotropicTransport # noqa: E501
- Returns
The type of this ConstCrossPlaneOrthotropicTransport. # noqa: E501
- Return type
str
simscale_sdk.models.const_iso_transport module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.const_iso_transport.ConstIsoTransport(type='CONST_ISO', conductivity=None, thermo=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'conductivity': 'conductivity', 'thermo': 'thermo', 'type': 'type'}¶
- property conductivity¶
Gets the conductivity of this ConstIsoTransport. # noqa: E501
- Returns
The conductivity of this ConstIsoTransport. # noqa: E501
- Return type
- openapi_types = {'conductivity': 'IsotropicConductivity', 'thermo': 'HConstThermo', 'type': 'str'}¶
- property thermo¶
Gets the thermo of this ConstIsoTransport. # noqa: E501
- Returns
The thermo of this ConstIsoTransport. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ConstIsoTransport. # noqa: E501
<p>The thermal conductivity of a material is a measure of its ability to conduct heat.<ul><li><strong>Isotropic</strong>: the thermal conductivity κ is the same in all directions.</li><li><strong>Orthotropic</strong>: the thermal conductivity is unique and independent in three orthogonal directions. It is defined by κ<sub>x</sub>, κ<sub>y</sub>, and κ<sub>z</sub>.</li><li><strong>Cross-plane orthotropic</strong>: it is defined by an <em>in-plane</em> conductivity, which is an isotropic conductivity on a given plane, and a <em>cross-plane<strong> </strong></em>conductivity, which acts in the direction normal to the aforementioned plane.</li></ul></p> Schema name: ConstIsoTransport # noqa: E501
- Returns
The type of this ConstIsoTransport. # noqa: E501
- Return type
str
simscale_sdk.models.const_transport module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.const_transport.ConstTransport(type='CONST', dynamic_viscosity=None, dynamic_viscosity_function=None, prandtl_number=None, turbulent_prandtl_number=None, thermo=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'dynamic_viscosity': 'dynamicViscosity', 'dynamic_viscosity_function': 'dynamicViscosityFunction', 'prandtl_number': 'prandtlNumber', 'thermo': 'thermo', 'turbulent_prandtl_number': 'turbulentPrandtlNumber', 'type': 'type'}¶
- property dynamic_viscosity¶
Gets the dynamic_viscosity of this ConstTransport. # noqa: E501
- Returns
The dynamic_viscosity of this ConstTransport. # noqa: E501
- Return type
- property dynamic_viscosity_function¶
Gets the dynamic_viscosity_function of this ConstTransport. # noqa: E501
- Returns
The dynamic_viscosity_function of this ConstTransport. # noqa: E501
- Return type
- openapi_types = {'dynamic_viscosity': 'DimensionalDynamicViscosity', 'dynamic_viscosity_function': 'DimensionalFunctionDynamicViscosity', 'prandtl_number': 'float', 'thermo': 'OneOfConstTransportThermo', 'turbulent_prandtl_number': 'float', 'type': 'str'}¶
- property prandtl_number¶
Gets the prandtl_number of this ConstTransport. # noqa: E501
Prandtl number (<i>Pr</i>) is the ratio of momentum transport to thermal tranport. Fluids with low <i>Pr</i> are free flowing and good for heat conduction. # noqa: E501
- Returns
The prandtl_number of this ConstTransport. # noqa: E501
- Return type
float
- property thermo¶
Gets the thermo of this ConstTransport. # noqa: E501
- Returns
The thermo of this ConstTransport. # noqa: E501
- Return type
OneOfConstTransportThermo
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulent_prandtl_number¶
Gets the turbulent_prandtl_number of this ConstTransport. # noqa: E501
Turbulent Prandtl number is used to calculate the heat transfer due to turbulent effects in the domain. # noqa: E501
- Returns
The turbulent_prandtl_number of this ConstTransport. # noqa: E501
- Return type
float
- property type¶
Gets the type of this ConstTransport. # noqa: E501
Schema name: ConstTransport # noqa: E501
- Returns
The type of this ConstTransport. # noqa: E501
- Return type
str
simscale_sdk.models.constant_contact_angle_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.constant_contact_angle_pfbc.ConstantContactAnglePFBC(type='CONSTANT_CONTACT_ANGLE', equilibrium_contact_angle=None, limit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'equilibrium_contact_angle': 'equilibriumContactAngle', 'limit': 'limit', 'type': 'type'}¶
- property equilibrium_contact_angle¶
Gets the equilibrium_contact_angle of this ConstantContactAnglePFBC. # noqa: E501
- Returns
The equilibrium_contact_angle of this ConstantContactAnglePFBC. # noqa: E501
- Return type
- property limit¶
Gets the limit of this ConstantContactAnglePFBC. # noqa: E501
- Returns
The limit of this ConstantContactAnglePFBC. # noqa: E501
- Return type
str
- openapi_types = {'equilibrium_contact_angle': 'DimensionalAngle', 'limit': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ConstantContactAnglePFBC. # noqa: E501
Schema name: ConstantContactAnglePFBC # noqa: E501
- Returns
The type of this ConstantContactAnglePFBC. # noqa: E501
- Return type
str
simscale_sdk.models.constant_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.constant_function.ConstantFunction(type='CONSTANT', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ConstantFunction. # noqa: E501
Schema name: ConstantFunction # noqa: E501
- Returns
The type of this ConstantFunction. # noqa: E501
- Return type
str
- property value¶
Gets the value of this ConstantFunction. # noqa: E501
- Returns
The value of this ConstantFunction. # noqa: E501
- Return type
float
simscale_sdk.models.contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.contact.Contact(type='CONTACT', connections=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'connections': 'connections', 'type': 'type'}¶
- property connections¶
Gets the connections of this Contact. # noqa: E501
- Returns
The connections of this Contact. # noqa: E501
- Return type
list[OneOfContactConnections]
- openapi_types = {'connections': 'list[OneOfContactConnections]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Contact. # noqa: E501
Schema name: Contact # noqa: E501
- Returns
The type of this Contact. # noqa: E501
- Return type
str
simscale_sdk.models.contact_interface_material_interface_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.contact_interface_material_interface_thermal.ContactInterfaceMaterialInterfaceThermal(type='CONTACT_INTERFACE_MATERIAL', conductivity_thickness_pairs=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'conductivity_thickness_pairs': 'conductivityThicknessPairs', 'type': 'type'}¶
- property conductivity_thickness_pairs¶
Gets the conductivity_thickness_pairs of this ContactInterfaceMaterialInterfaceThermal. # noqa: E501
- Returns
The conductivity_thickness_pairs of this ContactInterfaceMaterialInterfaceThermal. # noqa: E501
- Return type
- openapi_types = {'conductivity_thickness_pairs': 'list[ConductivityThicknessPair]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ContactInterfaceMaterialInterfaceThermal. # noqa: E501
Schema name: ContactInterfaceMaterialInterfaceThermal # noqa: E501
- Returns
The type of this ContactInterfaceMaterialInterfaceThermal. # noqa: E501
- Return type
str
simscale_sdk.models.contact_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.contact_result_control_item.ContactResultControlItem(type='CONTACT', name=None, contact_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_type': 'contactType', 'name': 'name', 'type': 'type'}¶
- property contact_type¶
Gets the contact_type of this ContactResultControlItem. # noqa: E501
- Returns
The contact_type of this ContactResultControlItem. # noqa: E501
- Return type
str
- property name¶
Gets the name of this ContactResultControlItem. # noqa: E501
- Returns
The name of this ContactResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'contact_type': 'str', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ContactResultControlItem. # noqa: E501
Schema name: ContactResultControlItem # noqa: E501
- Returns
The type of this ContactResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.convective_heat_flux_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.convective_heat_flux_bc.ConvectiveHeatFluxBC(type='CONVECTIVE_HEAT_FLUX', name=None, reference_temperature=None, heat_transfer_coefficient=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heat_transfer_coefficient': 'heatTransferCoefficient', 'name': 'name', 'reference_temperature': 'referenceTemperature', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property heat_transfer_coefficient¶
Gets the heat_transfer_coefficient of this ConvectiveHeatFluxBC. # noqa: E501
- Returns
The heat_transfer_coefficient of this ConvectiveHeatFluxBC. # noqa: E501
- Return type
- property name¶
Gets the name of this ConvectiveHeatFluxBC. # noqa: E501
- Returns
The name of this ConvectiveHeatFluxBC. # noqa: E501
- Return type
str
- openapi_types = {'heat_transfer_coefficient': 'DimensionalFunctionThermalTransmittance', 'name': 'str', 'reference_temperature': 'DimensionalFunctionTemperature', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property reference_temperature¶
Gets the reference_temperature of this ConvectiveHeatFluxBC. # noqa: E501
- Returns
The reference_temperature of this ConvectiveHeatFluxBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this ConvectiveHeatFluxBC. # noqa: E501
- Returns
The topological_reference of this ConvectiveHeatFluxBC. # noqa: E501
- Return type
- property type¶
Gets the type of this ConvectiveHeatFluxBC. # noqa: E501
This is a <b>heat flux</b> boundary condition representing a <b>convective heat flux</b> on the selected face groups. It is defined by the <b>reference temperature</b> (surrounding temperature) and the <b>convection coefficient</b>.<br /><br />Important remarks: <br /><ul><li>The convection coefficient is not only dependent on the material of the surrounding fluid but a property of the flow</li><li>You may define a <b>parameter dependent (x,y,z,t)</b> value by defining a formula or uploading a table (csv-file) for the <b>reference temperature</b> and the <b>convection coefficient</b></li></ul> Schema name: ConvectiveHeatFluxBC # noqa: E501
- Returns
The type of this ConvectiveHeatFluxBC. # noqa: E501
- Return type
str
simscale_sdk.models.convective_heat_transfer module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.convective_heat_transfer.ConvectiveHeatTransfer(type='CONVECTIVE_HEAT_TRANSFER', is_compressible=None, turbulence_model=None, time_dependency=None, enable_radiation=None, num_of_passive_species=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The advanced_concepts of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'enable_radiation': 'enableRadiation', 'initial_conditions': 'initialConditions', 'is_compressible': 'isCompressible', 'materials': 'materials', 'model': 'model', 'num_of_passive_species': 'numOfPassiveSpecies', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The boundary_conditions of this ConvectiveHeatTransfer. # noqa: E501
- Return type
list[OneOfConvectiveHeatTransferBoundaryConditions]
- property enable_radiation¶
Gets the enable_radiation of this ConvectiveHeatTransfer. # noqa: E501
Heat transfer through radiation takes place in the form of electromagnetic waves and it can be calculated in the simulation. This phenomenon becomes more important when the temperatures involved in the simulation are large. <a href=’https://www.simscale.com/docs/analysis-types/convective-heat-transfer-analysis/radiation/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_radiation of this ConvectiveHeatTransfer. # noqa: E501
- Return type
bool
- property initial_conditions¶
Gets the initial_conditions of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The initial_conditions of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- property is_compressible¶
Gets the is_compressible of this ConvectiveHeatTransfer. # noqa: E501
<ul><li>Toggle off <em>Compressible</em> for small temperature variations within the domain, for example, in natural convection simulations (Boussinesq approximation). Use Gauge pressure (0 Pa). </li><li>Toggle on <em>Compressible</em> to calculate resulting density variations within the domain based on pressure and temperature. Use Absolute pressure (for example, 101325 Pa at sea level)</li></ul> # noqa: E501
- Returns
The is_compressible of this ConvectiveHeatTransfer. # noqa: E501
- Return type
bool
- property materials¶
Gets the materials of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The materials of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- property model¶
Gets the model of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The model of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- property num_of_passive_species¶
Gets the num_of_passive_species of this ConvectiveHeatTransfer. # noqa: E501
Select the number of passive species involved in the simulation. Passive species allow you to simulate the transport of a scalar quantity within a fluid flow without affecting it. <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/#passive-species’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The num_of_passive_species of this ConvectiveHeatTransfer. # noqa: E501
- Return type
int
- property numerics¶
Gets the numerics of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The numerics of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfConvectiveHeatTransferBoundaryConditions]', 'enable_radiation': 'bool', 'initial_conditions': 'FluidInitialConditions', 'is_compressible': 'bool', 'materials': 'ConvectiveHeatTransferMaterials', 'model': 'FluidModel', 'num_of_passive_species': 'int', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'time_dependency': 'OneOfConvectiveHeatTransferTimeDependency', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The result_control of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The simulation_control of this ConvectiveHeatTransfer. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this ConvectiveHeatTransfer. # noqa: E501
- Returns
The time_dependency of this ConvectiveHeatTransfer. # noqa: E501
- Return type
OneOfConvectiveHeatTransferTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this ConvectiveHeatTransfer. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this ConvectiveHeatTransfer. # noqa: E501
- Return type
str
- property type¶
Gets the type of this ConvectiveHeatTransfer. # noqa: E501
Schema name: ConvectiveHeatTransfer # noqa: E501
- Returns
The type of this ConvectiveHeatTransfer. # noqa: E501
- Return type
str
simscale_sdk.models.convective_heat_transfer_materials module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.convective_heat_transfer_materials.ConvectiveHeatTransferMaterials(fluids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fluids': 'fluids'}¶
- property fluids¶
Gets the fluids of this ConvectiveHeatTransferMaterials. # noqa: E501
- Returns
The fluids of this ConvectiveHeatTransferMaterials. # noqa: E501
- Return type
list[OneOfConvectiveHeatTransferMaterialsFluids]
- openapi_types = {'fluids': 'list[OneOfConvectiveHeatTransferMaterialsFluids]'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.corrected_surface_normal_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.corrected_surface_normal_gradient_scheme.CorrectedSurfaceNormalGradientScheme(type='CORRECTED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CorrectedSurfaceNormalGradientScheme. # noqa: E501
Schema name: CorrectedSurfaceNormalGradientScheme # noqa: E501
- Returns
The type of this CorrectedSurfaceNormalGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.coulomb_friction module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.coulomb_friction.CoulombFriction(type='COULOMB_FRICTION', nonlinearity_resolution=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'nonlinearity_resolution': 'nonlinearityResolution', 'type': 'type'}¶
- property nonlinearity_resolution¶
Gets the nonlinearity_resolution of this CoulombFriction. # noqa: E501
- Returns
The nonlinearity_resolution of this CoulombFriction. # noqa: E501
- Return type
OneOfCoulombFrictionNonlinearityResolution
- openapi_types = {'nonlinearity_resolution': 'OneOfCoulombFrictionNonlinearityResolution', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CoulombFriction. # noqa: E501
Schema name: CoulombFriction # noqa: E501
- Returns
The type of this CoulombFriction. # noqa: E501
- Return type
str
simscale_sdk.models.coupled_conjugate_heat_transfer module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.coupled_conjugate_heat_transfer.CoupledConjugateHeatTransfer(type='COUPLED_CONJUGATE_HEAT_TRANSFER', is_compressible=None, enable_radiation=None, enable_solar_load=None, turbulence_model=None, connection_groups=None, model=None, solar_calculator=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, contact_handling_mode=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The advanced_concepts of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'contact_handling_mode': 'contactHandlingMode', 'enable_radiation': 'enableRadiation', 'enable_solar_load': 'enableSolarLoad', 'initial_conditions': 'initialConditions', 'is_compressible': 'isCompressible', 'materials': 'materials', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'solar_calculator': 'solarCalculator', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The boundary_conditions of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
list[OneOfCoupledConjugateHeatTransferBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The connection_groups of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
list[FluidInterface]
- property contact_handling_mode¶
Gets the contact_handling_mode of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The contact_handling_mode of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
str
- property enable_radiation¶
Gets the enable_radiation of this CoupledConjugateHeatTransfer. # noqa: E501
Heat transfer through radiation takes place in the form of electromagnetic waves and it can be calculated in the simulation. This phenomenon becomes more important when the temperatures involved in the simulation are large. <a href=’https://www.simscale.com/docs/analysis-types/convective-heat-transfer-analysis/radiation/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_radiation of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
bool
- property enable_solar_load¶
Gets the enable_solar_load of this CoupledConjugateHeatTransfer. # noqa: E501
<b>Solar load</b> on boundary patches. Heats boundaries externally or, if solar rays enter the domain by transparent or semi-transparent boundaries, it heats boundaries also internally, internally. Sun direction and solar load model are defined in the <b>Solar calculator</b>. <ul><li>Can not be combined with surface to surface radiation.</li><li>Can only be used for convective heat transfer.</li><li>Secondary, reflecting rays are not taken into account.</li></ul> <a href=’https://www.simscale.com/docs/analysis-types/conjugate-heat-transfer-analysis/solar-load/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_solar_load of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
bool
- property initial_conditions¶
Gets the initial_conditions of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The initial_conditions of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- property is_compressible¶
Gets the is_compressible of this CoupledConjugateHeatTransfer. # noqa: E501
<ul><li>Toggle off <em>Compressible</em> for small temperature variations within the domain, for example, in natural convection simulations (Boussinesq approximation). Use Gauge pressure (0 Pa). </li><li>Toggle on <em>Compressible</em> to calculate resulting density variations within the domain based on pressure and temperature. Use Absolute pressure (for example, 101325 Pa at sea level)</li></ul> # noqa: E501
- Returns
The is_compressible of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
bool
- property materials¶
Gets the materials of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The materials of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- property model¶
Gets the model of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The model of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The numerics of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfCoupledConjugateHeatTransferBoundaryConditions]', 'connection_groups': 'list[FluidInterface]', 'contact_handling_mode': 'str', 'enable_radiation': 'bool', 'enable_solar_load': 'bool', 'initial_conditions': 'FluidInitialConditions', 'is_compressible': 'bool', 'materials': 'CoupledConjugateHeatTransferMaterials', 'model': 'FluidModel', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'solar_calculator': 'SolarCalculator', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The result_control of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The simulation_control of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- property solar_calculator¶
Gets the solar_calculator of this CoupledConjugateHeatTransfer. # noqa: E501
- Returns
The solar_calculator of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this CoupledConjugateHeatTransfer. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
str
- property type¶
Gets the type of this CoupledConjugateHeatTransfer. # noqa: E501
Schema name: CoupledConjugateHeatTransfer # noqa: E501
- Returns
The type of this CoupledConjugateHeatTransfer. # noqa: E501
- Return type
str
simscale_sdk.models.coupled_conjugate_heat_transfer_materials module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.coupled_conjugate_heat_transfer_materials.CoupledConjugateHeatTransferMaterials(fluids=None, solids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fluids': 'fluids', 'solids': 'solids'}¶
- property fluids¶
Gets the fluids of this CoupledConjugateHeatTransferMaterials. # noqa: E501
- Returns
The fluids of this CoupledConjugateHeatTransferMaterials. # noqa: E501
- Return type
list[OneOfCoupledConjugateHeatTransferMaterialsFluids]
- openapi_types = {'fluids': 'list[OneOfCoupledConjugateHeatTransferMaterialsFluids]', 'solids': 'list[SolidCompressibleMaterial]'}¶
- property solids¶
Gets the solids of this CoupledConjugateHeatTransferMaterials. # noqa: E501
- Returns
The solids of this CoupledConjugateHeatTransferMaterials. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.coupled_interface_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.coupled_interface_thermal.CoupledInterfaceThermal(type='COUPLED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CoupledInterfaceThermal. # noqa: E501
Schema name: CoupledInterfaceThermal # noqa: E501
- Returns
The type of this CoupledInterfaceThermal. # noqa: E501
- Return type
str
simscale_sdk.models.cpu_time_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cpu_time_write_control.CpuTimeWriteControl(type='CPU_TIME', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'DimensionalTime'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CpuTimeWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: CpuTimeWriteControl # noqa: E501
- Returns
The type of this CpuTimeWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this CpuTimeWriteControl. # noqa: E501
- Returns
The write_interval of this CpuTimeWriteControl. # noqa: E501
- Return type
simscale_sdk.models.create_material_group_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.create_material_group_request.CreateMaterialGroupRequest(name=None, metadata=None, public=None, team_group_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'metadata': 'metadata', 'name': 'name', 'public': 'public', 'team_group_id': 'teamGroupId'}¶
- property metadata¶
Gets the metadata of this CreateMaterialGroupRequest. # noqa: E501
- Returns
The metadata of this CreateMaterialGroupRequest. # noqa: E501
- Return type
object
- property name¶
Gets the name of this CreateMaterialGroupRequest. # noqa: E501
The name of the material group. # noqa: E501
- Returns
The name of this CreateMaterialGroupRequest. # noqa: E501
- Return type
str
- openapi_types = {'metadata': 'object', 'name': 'str', 'public': 'bool', 'team_group_id': 'int'}¶
- property public¶
Gets the public of this CreateMaterialGroupRequest. # noqa: E501
- Returns
The public of this CreateMaterialGroupRequest. # noqa: E501
- Return type
bool
- property team_group_id¶
Gets the team_group_id of this CreateMaterialGroupRequest. # noqa: E501
The material group will be assigned to this team group id. This field can only be used by support group members. # noqa: E501
- Returns
The team_group_id of this CreateMaterialGroupRequest. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.create_material_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.create_material_request.CreateMaterialRequest(name=None, metadata=None, properties=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'metadata': 'metadata', 'name': 'name', 'properties': 'properties'}¶
- property metadata¶
Gets the metadata of this CreateMaterialRequest. # noqa: E501
- Returns
The metadata of this CreateMaterialRequest. # noqa: E501
- Return type
object
- property name¶
Gets the name of this CreateMaterialRequest. # noqa: E501
The material name. # noqa: E501
- Returns
The name of this CreateMaterialRequest. # noqa: E501
- Return type
str
- openapi_types = {'metadata': 'object', 'name': 'str', 'properties': 'dict(str, OneOfMaterialProperty)'}¶
- property properties¶
Gets the properties of this CreateMaterialRequest. # noqa: E501
The material properties. # noqa: E501
- Returns
The properties of this CreateMaterialRequest. # noqa: E501
- Return type
dict(str, OneOfMaterialProperty)
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.create_nested_material_group_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.create_nested_material_group_request.CreateNestedMaterialGroupRequest(name=None, metadata=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'metadata': 'metadata', 'name': 'name'}¶
- property metadata¶
Gets the metadata of this CreateNestedMaterialGroupRequest. # noqa: E501
- Returns
The metadata of this CreateNestedMaterialGroupRequest. # noqa: E501
- Return type
object
- property name¶
Gets the name of this CreateNestedMaterialGroupRequest. # noqa: E501
The name of the material group. # noqa: E501
- Returns
The name of this CreateNestedMaterialGroupRequest. # noqa: E501
- Return type
str
- openapi_types = {'metadata': 'object', 'name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.cross_plane_custom_orientation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cross_plane_custom_orientation.CrossPlaneCustomOrientation(type='CROSS_PLANE', cross_plane_orientation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cross_plane_orientation': 'crossPlaneOrientation', 'type': 'type'}¶
- property cross_plane_orientation¶
Gets the cross_plane_orientation of this CrossPlaneCustomOrientation. # noqa: E501
- Returns
The cross_plane_orientation of this CrossPlaneCustomOrientation. # noqa: E501
- Return type
- openapi_types = {'cross_plane_orientation': 'DimensionalVectorLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CrossPlaneCustomOrientation. # noqa: E501
Schema name: CrossPlaneCustomOrientation # noqa: E501
- Returns
The type of this CrossPlaneCustomOrientation. # noqa: E501
- Return type
str
simscale_sdk.models.cross_plane_orthotropic_conductivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cross_plane_orthotropic_conductivity.CrossPlaneOrthotropicConductivity(type='CROSS_PLANE_ORTHOTROPIC', in_plane_conductivity=None, cross_plane_conductivity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cross_plane_conductivity': 'crossPlaneConductivity', 'in_plane_conductivity': 'inPlaneConductivity', 'type': 'type'}¶
- property cross_plane_conductivity¶
Gets the cross_plane_conductivity of this CrossPlaneOrthotropicConductivity. # noqa: E501
- Returns
The cross_plane_conductivity of this CrossPlaneOrthotropicConductivity. # noqa: E501
- Return type
- property in_plane_conductivity¶
Gets the in_plane_conductivity of this CrossPlaneOrthotropicConductivity. # noqa: E501
- Returns
The in_plane_conductivity of this CrossPlaneOrthotropicConductivity. # noqa: E501
- Return type
- openapi_types = {'cross_plane_conductivity': 'DimensionalFunctionThermalConductivity', 'in_plane_conductivity': 'DimensionalFunctionThermalConductivity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CrossPlaneOrthotropicConductivity. # noqa: E501
Schema name: CrossPlaneOrthotropicConductivity # noqa: E501
- Returns
The type of this CrossPlaneOrthotropicConductivity. # noqa: E501
- Return type
str
simscale_sdk.models.cross_power_law_viscosity_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cross_power_law_viscosity_model.CrossPowerLawViscosityModel(type='CROSS_POWER_LAW', nu0=None, nu_inf=None, m=None, n=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'m': 'm', 'n': 'n', 'nu0': 'nu0', 'nu_inf': 'nuInf', 'type': 'type'}¶
- property m¶
Gets the m of this CrossPowerLawViscosityModel. # noqa: E501
- Returns
The m of this CrossPowerLawViscosityModel. # noqa: E501
- Return type
- property n¶
Gets the n of this CrossPowerLawViscosityModel. # noqa: E501
- Returns
The n of this CrossPowerLawViscosityModel. # noqa: E501
- Return type
- property nu0¶
Gets the nu0 of this CrossPowerLawViscosityModel. # noqa: E501
- Returns
The nu0 of this CrossPowerLawViscosityModel. # noqa: E501
- Return type
- property nu_inf¶
Gets the nu_inf of this CrossPowerLawViscosityModel. # noqa: E501
- Returns
The nu_inf of this CrossPowerLawViscosityModel. # noqa: E501
- Return type
- openapi_types = {'m': 'DimensionalTime', 'n': 'DimensionalDimensionless', 'nu0': 'DimensionalKinematicViscosity', 'nu_inf': 'DimensionalKinematicViscosity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CrossPowerLawViscosityModel. # noqa: E501
Choose between <a href=’https://www.simscale.com/docs/simulation-setup/materials/#newtonian-model’ target=’_blank’>Newtonian</a> and <a href=’https://www.simscale.com/docs/simulation-setup/materials/non-newtonian-models/’ target=’_blank’>Non-Newtonian</a> viscosity models. Schema name: CrossPowerLawViscosityModel # noqa: E501
- Returns
The type of this CrossPowerLawViscosityModel. # noqa: E501
- Return type
str
simscale_sdk.models.cube_root_vol_les_delta module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cube_root_vol_les_delta.CubeRootVolLesDelta(type='CUBE_ROOT_VOL', delta_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'delta_coefficient': 'deltaCoefficient', 'type': 'type'}¶
- property delta_coefficient¶
Gets the delta_coefficient of this CubeRootVolLesDelta. # noqa: E501
- Returns
The delta_coefficient of this CubeRootVolLesDelta. # noqa: E501
- Return type
float
- openapi_types = {'delta_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CubeRootVolLesDelta. # noqa: E501
Schema name: CubeRootVolLesDelta # noqa: E501
- Returns
The type of this CubeRootVolLesDelta. # noqa: E501
- Return type
str
simscale_sdk.models.cubic_interpolation_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cubic_interpolation_scheme.CubicInterpolationScheme(type='CUBIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CubicInterpolationScheme. # noqa: E501
Schema name: CubicInterpolationScheme # noqa: E501
- Returns
The type of this CubicInterpolationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.custom_fluid_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_fluid_bc.CustomFluidBC(type='CUSTOM_V37', name=None, velocity=None, pressure=None, pressure_rgh=None, gauge_pressure=None, gauge_pressure_rgh=None, temperature=None, turbulent_kinetic_energy=None, omega_dissipation_rate=None, epsilon_dissipation_rate=None, eddy_viscosity=None, eddy_viscosity_compressible=None, nu_tilda=None, turbulent_thermal_diffusivity=None, turbulent_thermal_diffusivity_compressible=None, turbulent_dynamic_viscosity=None, passive_scalars=None, phase_fraction=None, net_radiative_heat_flux=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'eddy_viscosity': 'eddyViscosity', 'eddy_viscosity_compressible': 'eddyViscosityCompressible', 'epsilon_dissipation_rate': 'epsilonDissipationRate', 'gauge_pressure': 'gaugePressure', 'gauge_pressure_rgh': 'gaugePressureRgh', 'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'nu_tilda': 'nuTilda', 'omega_dissipation_rate': 'omegaDissipationRate', 'passive_scalars': 'passiveScalars', 'phase_fraction': 'phaseFraction', 'pressure': 'pressure', 'pressure_rgh': 'pressureRgh', 'temperature': 'temperature', 'topological_reference': 'topologicalReference', 'turbulent_dynamic_viscosity': 'turbulentDynamicViscosity', 'turbulent_kinetic_energy': 'turbulentKineticEnergy', 'turbulent_thermal_diffusivity': 'turbulentThermalDiffusivity', 'turbulent_thermal_diffusivity_compressible': 'turbulentThermalDiffusivityCompressible', 'type': 'type', 'velocity': 'velocity'}¶
- property eddy_viscosity¶
Gets the eddy_viscosity of this CustomFluidBC. # noqa: E501
- Returns
The eddy_viscosity of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCEddyViscosity
- property eddy_viscosity_compressible¶
Gets the eddy_viscosity_compressible of this CustomFluidBC. # noqa: E501
- Returns
The eddy_viscosity_compressible of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCEddyViscosityCompressible
- property epsilon_dissipation_rate¶
Gets the epsilon_dissipation_rate of this CustomFluidBC. # noqa: E501
- Returns
The epsilon_dissipation_rate of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCEpsilonDissipationRate
- property gauge_pressure¶
Gets the gauge_pressure of this CustomFluidBC. # noqa: E501
- Returns
The gauge_pressure of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCGaugePressure
- property gauge_pressure_rgh¶
Gets the gauge_pressure_rgh of this CustomFluidBC. # noqa: E501
- Returns
The gauge_pressure_rgh of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCGaugePressureRgh
- property name¶
Gets the name of this CustomFluidBC. # noqa: E501
- Returns
The name of this CustomFluidBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this CustomFluidBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCNetRadiativeHeatFlux
- property nu_tilda¶
Gets the nu_tilda of this CustomFluidBC. # noqa: E501
- Returns
The nu_tilda of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCNuTilda
- property omega_dissipation_rate¶
Gets the omega_dissipation_rate of this CustomFluidBC. # noqa: E501
- Returns
The omega_dissipation_rate of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCOmegaDissipationRate
- openapi_types = {'eddy_viscosity': 'OneOfCustomFluidBCEddyViscosity', 'eddy_viscosity_compressible': 'OneOfCustomFluidBCEddyViscosityCompressible', 'epsilon_dissipation_rate': 'OneOfCustomFluidBCEpsilonDissipationRate', 'gauge_pressure': 'OneOfCustomFluidBCGaugePressure', 'gauge_pressure_rgh': 'OneOfCustomFluidBCGaugePressureRgh', 'name': 'str', 'net_radiative_heat_flux': 'OneOfCustomFluidBCNetRadiativeHeatFlux', 'nu_tilda': 'OneOfCustomFluidBCNuTilda', 'omega_dissipation_rate': 'OneOfCustomFluidBCOmegaDissipationRate', 'passive_scalars': 'list[OneOfCustomFluidBCPassiveScalars]', 'phase_fraction': 'OneOfCustomFluidBCPhaseFraction', 'pressure': 'OneOfCustomFluidBCPressure', 'pressure_rgh': 'OneOfCustomFluidBCPressureRgh', 'temperature': 'OneOfCustomFluidBCTemperature', 'topological_reference': 'TopologicalReference', 'turbulent_dynamic_viscosity': 'OneOfCustomFluidBCTurbulentDynamicViscosity', 'turbulent_kinetic_energy': 'OneOfCustomFluidBCTurbulentKineticEnergy', 'turbulent_thermal_diffusivity': 'OneOfCustomFluidBCTurbulentThermalDiffusivity', 'turbulent_thermal_diffusivity_compressible': 'OneOfCustomFluidBCTurbulentThermalDiffusivityCompressible', 'type': 'str', 'velocity': 'OneOfCustomFluidBCVelocity'}¶
- property passive_scalars¶
Gets the passive_scalars of this CustomFluidBC. # noqa: E501
Please choose a boundary condition for passive scalar (T). # noqa: E501
- Returns
The passive_scalars of this CustomFluidBC. # noqa: E501
- Return type
list[OneOfCustomFluidBCPassiveScalars]
- property phase_fraction¶
Gets the phase_fraction of this CustomFluidBC. # noqa: E501
- Returns
The phase_fraction of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCPhaseFraction
- property pressure¶
Gets the pressure of this CustomFluidBC. # noqa: E501
- Returns
The pressure of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCPressure
- property pressure_rgh¶
Gets the pressure_rgh of this CustomFluidBC. # noqa: E501
- Returns
The pressure_rgh of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCPressureRgh
- property temperature¶
Gets the temperature of this CustomFluidBC. # noqa: E501
- Returns
The temperature of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCTemperature
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this CustomFluidBC. # noqa: E501
- Returns
The topological_reference of this CustomFluidBC. # noqa: E501
- Return type
- property turbulent_dynamic_viscosity¶
Gets the turbulent_dynamic_viscosity of this CustomFluidBC. # noqa: E501
- Returns
The turbulent_dynamic_viscosity of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCTurbulentDynamicViscosity
- property turbulent_kinetic_energy¶
Gets the turbulent_kinetic_energy of this CustomFluidBC. # noqa: E501
- Returns
The turbulent_kinetic_energy of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCTurbulentKineticEnergy
- property turbulent_thermal_diffusivity¶
Gets the turbulent_thermal_diffusivity of this CustomFluidBC. # noqa: E501
- Returns
The turbulent_thermal_diffusivity of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCTurbulentThermalDiffusivity
- property turbulent_thermal_diffusivity_compressible¶
Gets the turbulent_thermal_diffusivity_compressible of this CustomFluidBC. # noqa: E501
- Returns
The turbulent_thermal_diffusivity_compressible of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCTurbulentThermalDiffusivityCompressible
- property type¶
Gets the type of this CustomFluidBC. # noqa: E501
This boundary condition allows the user to choose conditions for each physical variable separately. It provides full flexibility over the choice of boundary conditions to make advanced customization possible. Schema name: CustomFluidBC # noqa: E501
- Returns
The type of this CustomFluidBC. # noqa: E501
- Return type
str
- property velocity¶
Gets the velocity of this CustomFluidBC. # noqa: E501
- Returns
The velocity of this CustomFluidBC. # noqa: E501
- Return type
OneOfCustomFluidBCVelocity
simscale_sdk.models.custom_omega_dissipation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_omega_dissipation.CustomOmegaDissipation(type='CUSTOM_DISSIPATION', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionSpecificTurbulenceDissipationRate'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CustomOmegaDissipation. # noqa: E501
Schema name: CustomOmegaDissipation # noqa: E501
- Returns
The type of this CustomOmegaDissipation. # noqa: E501
- Return type
str
- property value¶
Gets the value of this CustomOmegaDissipation. # noqa: E501
- Returns
The value of this CustomOmegaDissipation. # noqa: E501
- Return type
simscale_sdk.models.custom_orientation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_orientation.CustomOrientation(type='CUSTOM', unit_vector1=None, unit_vector2=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'unit_vector1': 'unitVector1', 'unit_vector2': 'unitVector2'}¶
- openapi_types = {'type': 'str', 'unit_vector1': 'DimensionalVectorLength', 'unit_vector2': 'DimensionalVectorLength'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CustomOrientation. # noqa: E501
Schema name: CustomOrientation # noqa: E501
- Returns
The type of this CustomOrientation. # noqa: E501
- Return type
str
- property unit_vector1¶
Gets the unit_vector1 of this CustomOrientation. # noqa: E501
- Returns
The unit_vector1 of this CustomOrientation. # noqa: E501
- Return type
- property unit_vector2¶
Gets the unit_vector2 of this CustomOrientation. # noqa: E501
- Returns
The unit_vector2 of this CustomOrientation. # noqa: E501
- Return type
simscale_sdk.models.custom_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_resolution.CustomResolution(type='CUSTOM_RESOLUTION', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'DimensionalTime'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CustomResolution. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: CustomResolution # noqa: E501
- Returns
The type of this CustomResolution. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this CustomResolution. # noqa: E501
- Returns
The write_interval of this CustomResolution. # noqa: E501
- Return type
simscale_sdk.models.custom_solar_load module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_solar_load.CustomSolarLoad(type='CUSTOM_SOLAR_LOAD', direct_solar_load=None, diffuse_solar_load=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'diffuse_solar_load': 'diffuseSolarLoad', 'direct_solar_load': 'directSolarLoad', 'type': 'type'}¶
- property diffuse_solar_load¶
Gets the diffuse_solar_load of this CustomSolarLoad. # noqa: E501
- Returns
The diffuse_solar_load of this CustomSolarLoad. # noqa: E501
- Return type
- property direct_solar_load¶
Gets the direct_solar_load of this CustomSolarLoad. # noqa: E501
- Returns
The direct_solar_load of this CustomSolarLoad. # noqa: E501
- Return type
- openapi_types = {'diffuse_solar_load': 'DimensionalHeatFlux', 'direct_solar_load': 'DimensionalHeatFlux', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CustomSolarLoad. # noqa: E501
Schema name: CustomSolarLoad # noqa: E501
- Returns
The type of this CustomSolarLoad. # noqa: E501
- Return type
str
simscale_sdk.models.custom_sun_direction module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_sun_direction.CustomSunDirection(type='CUSTOM_SOLAR_DIRECTION', sun_direction_vector=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'sun_direction_vector': 'sunDirectionVector', 'type': 'type'}¶
- openapi_types = {'sun_direction_vector': 'DimensionalVectorLength', 'type': 'str'}¶
- property sun_direction_vector¶
Gets the sun_direction_vector of this CustomSunDirection. # noqa: E501
- Returns
The sun_direction_vector of this CustomSunDirection. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CustomSunDirection. # noqa: E501
Schema name: CustomSunDirection # noqa: E501
- Returns
The type of this CustomSunDirection. # noqa: E501
- Return type
str
simscale_sdk.models.custom_tree module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.custom_tree.CustomTree(type='CUSTOM_TREE', leaf_area_index=None, average_tree_height=None, drag_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_tree_height': 'averageTreeHeight', 'drag_coefficient': 'dragCoefficient', 'leaf_area_index': 'leafAreaIndex', 'type': 'type'}¶
- property average_tree_height¶
Gets the average_tree_height of this CustomTree. # noqa: E501
- Returns
The average_tree_height of this CustomTree. # noqa: E501
- Return type
- property drag_coefficient¶
Gets the drag_coefficient of this CustomTree. # noqa: E501
Drag coefficient of the tree canopy. # noqa: E501
- Returns
The drag_coefficient of this CustomTree. # noqa: E501
- Return type
float
- property leaf_area_index¶
Gets the leaf_area_index of this CustomTree. # noqa: E501
Leaf Area Index (LAI) is a dimensionless quantity that is defined as the leaf area per unit ground surface area in broadleaf canopies # noqa: E501
- Returns
The leaf_area_index of this CustomTree. # noqa: E501
- Return type
float
- openapi_types = {'average_tree_height': 'DimensionalLength', 'drag_coefficient': 'float', 'leaf_area_index': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CustomTree. # noqa: E501
Schema name: CustomTree # noqa: E501
- Returns
The type of this CustomTree. # noqa: E501
- Return type
str
simscale_sdk.models.cutting_plane module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cutting_plane.CuttingPlane(name=None, center=None, normal=None, opacity=1.0, clipping=True, vector_grid_spacing=None, scalar_field=None, vector_field=None, project_vectors_onto_plane=False, render_mode=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center': 'center', 'clipping': 'clipping', 'name': 'name', 'normal': 'normal', 'opacity': 'opacity', 'project_vectors_onto_plane': 'projectVectorsOntoPlane', 'render_mode': 'renderMode', 'scalar_field': 'scalarField', 'vector_field': 'vectorField', 'vector_grid_spacing': 'vectorGridSpacing'}¶
- property center¶
Gets the center of this CuttingPlane. # noqa: E501
- Returns
The center of this CuttingPlane. # noqa: E501
- Return type
- property clipping¶
Gets the clipping of this CuttingPlane. # noqa: E501
- Returns
The clipping of this CuttingPlane. # noqa: E501
- Return type
bool
- property name¶
Gets the name of this CuttingPlane. # noqa: E501
- Returns
The name of this CuttingPlane. # noqa: E501
- Return type
str
- property normal¶
Gets the normal of this CuttingPlane. # noqa: E501
- Returns
The normal of this CuttingPlane. # noqa: E501
- Return type
- property opacity¶
Gets the opacity of this CuttingPlane. # noqa: E501
- Returns
The opacity of this CuttingPlane. # noqa: E501
- Return type
float
- openapi_types = {'center': 'Vector3D', 'clipping': 'bool', 'name': 'str', 'normal': 'Vector3D', 'opacity': 'float', 'project_vectors_onto_plane': 'bool', 'render_mode': 'RenderMode', 'scalar_field': 'ScalarField', 'vector_field': 'VectorField', 'vector_grid_spacing': 'float'}¶
- property project_vectors_onto_plane¶
Gets the project_vectors_onto_plane of this CuttingPlane. # noqa: E501
If a vectorField is provided, this flag will project the vector field onto the cutting plane. # noqa: E501
- Returns
The project_vectors_onto_plane of this CuttingPlane. # noqa: E501
- Return type
bool
- property render_mode¶
Gets the render_mode of this CuttingPlane. # noqa: E501
- Returns
The render_mode of this CuttingPlane. # noqa: E501
- Return type
- property scalar_field¶
Gets the scalar_field of this CuttingPlane. # noqa: E501
- Returns
The scalar_field of this CuttingPlane. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vector_field¶
Gets the vector_field of this CuttingPlane. # noqa: E501
- Returns
The vector_field of this CuttingPlane. # noqa: E501
- Return type
- property vector_grid_spacing¶
Gets the vector_grid_spacing of this CuttingPlane. # noqa: E501
This field is required if projectVectorsOntoPlane is set to true. # noqa: E501
- Returns
The vector_grid_spacing of this CuttingPlane. # noqa: E501
- Return type
float
simscale_sdk.models.cyclic_symmetry_contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cyclic_symmetry_contact.CyclicSymmetryContact(type='CYCLIC_SYMMETRY', name=None, enable_heat_transfer=None, axis_origin=None, axis_direction=None, sector_angle=None, master_topological_reference=None, slave_topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'axis_direction': 'axisDirection', 'axis_origin': 'axisOrigin', 'enable_heat_transfer': 'enableHeatTransfer', 'master_topological_reference': 'masterTopologicalReference', 'name': 'name', 'sector_angle': 'sectorAngle', 'slave_topological_reference': 'slaveTopologicalReference', 'type': 'type'}¶
- property axis_direction¶
Gets the axis_direction of this CyclicSymmetryContact. # noqa: E501
- Returns
The axis_direction of this CyclicSymmetryContact. # noqa: E501
- Return type
- property axis_origin¶
Gets the axis_origin of this CyclicSymmetryContact. # noqa: E501
- Returns
The axis_origin of this CyclicSymmetryContact. # noqa: E501
- Return type
- property enable_heat_transfer¶
Gets the enable_heat_transfer of this CyclicSymmetryContact. # noqa: E501
- Returns
The enable_heat_transfer of this CyclicSymmetryContact. # noqa: E501
- Return type
str
- property master_topological_reference¶
Gets the master_topological_reference of this CyclicSymmetryContact. # noqa: E501
- Returns
The master_topological_reference of this CyclicSymmetryContact. # noqa: E501
- Return type
- property name¶
Gets the name of this CyclicSymmetryContact. # noqa: E501
- Returns
The name of this CyclicSymmetryContact. # noqa: E501
- Return type
str
- openapi_types = {'axis_direction': 'DimensionalVectorLength', 'axis_origin': 'DimensionalVectorLength', 'enable_heat_transfer': 'str', 'master_topological_reference': 'TopologicalReference', 'name': 'str', 'sector_angle': 'DimensionalAngle', 'slave_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property sector_angle¶
Gets the sector_angle of this CyclicSymmetryContact. # noqa: E501
- Returns
The sector_angle of this CyclicSymmetryContact. # noqa: E501
- Return type
- property slave_topological_reference¶
Gets the slave_topological_reference of this CyclicSymmetryContact. # noqa: E501
- Returns
The slave_topological_reference of this CyclicSymmetryContact. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this CyclicSymmetryContact. # noqa: E501
Schema name: CyclicSymmetryContact # noqa: E501
- Returns
The type of this CyclicSymmetryContact. # noqa: E501
- Return type
str
simscale_sdk.models.cylinder module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cylinder.Cylinder(type='CYLINDER', id=None, name=None, reference=None, axis=None, radius=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'axis': 'axis', 'id': 'id', 'name': 'name', 'radius': 'radius', 'reference': 'reference', 'type': 'type'}¶
- property axis¶
Gets the axis of this Cylinder. # noqa: E501
- Returns
The axis of this Cylinder. # noqa: E501
- Return type
- property id¶
Gets the id of this Cylinder. # noqa: E501
- Returns
The id of this Cylinder. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Cylinder. # noqa: E501
- Returns
The name of this Cylinder. # noqa: E501
- Return type
str
- openapi_types = {'axis': 'DimensionalVectorLength', 'id': 'str', 'name': 'str', 'radius': 'DimensionalLength', 'reference': 'DimensionalVectorLength', 'type': 'str'}¶
- property radius¶
Gets the radius of this Cylinder. # noqa: E501
- Returns
The radius of this Cylinder. # noqa: E501
- Return type
- property reference¶
Gets the reference of this Cylinder. # noqa: E501
- Returns
The reference of this Cylinder. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Cylinder. # noqa: E501
Schema name: Cylinder # noqa: E501
- Returns
The type of this Cylinder. # noqa: E501
- Return type
str
simscale_sdk.models.cylinders_visualization_style module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.cylinders_visualization_style.CylindersVisualizationStyle(representation='CYLINDERS', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'representation': 'representation'}¶
- openapi_types = {'representation': 'str'}¶
- property representation¶
Gets the representation of this CylindersVisualizationStyle. # noqa: E501
The representation to use for particle traces. # noqa: E501
- Returns
The representation of this CylindersVisualizationStyle. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.darcy_forchheimer_medium module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.darcy_forchheimer_medium.DarcyForchheimerMedium(type='DARCY_FORCHHEIMER', name=None, coefficient_d=None, coefficient_f=None, orientation=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'coefficient_d': 'coefficientD', 'coefficient_f': 'coefficientF', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'orientation': 'orientation', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property coefficient_d¶
Gets the coefficient_d of this DarcyForchheimerMedium. # noqa: E501
- Returns
The coefficient_d of this DarcyForchheimerMedium. # noqa: E501
- Return type
- property coefficient_f¶
Gets the coefficient_f of this DarcyForchheimerMedium. # noqa: E501
- Returns
The coefficient_f of this DarcyForchheimerMedium. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this DarcyForchheimerMedium. # noqa: E501
- Returns
The geometry_primitive_uuids of this DarcyForchheimerMedium. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this DarcyForchheimerMedium. # noqa: E501
- Returns
The name of this DarcyForchheimerMedium. # noqa: E501
- Return type
str
- openapi_types = {'coefficient_d': 'DimensionalVectorReciprocalPermeability', 'coefficient_f': 'DimensionalVectorAbsorptivity', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'orientation': 'OneOfDarcyForchheimerMediumOrientation', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property orientation¶
Gets the orientation of this DarcyForchheimerMedium. # noqa: E501
- Returns
The orientation of this DarcyForchheimerMedium. # noqa: E501
- Return type
OneOfDarcyForchheimerMediumOrientation
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this DarcyForchheimerMedium. # noqa: E501
- Returns
The topological_reference of this DarcyForchheimerMedium. # noqa: E501
- Return type
- property type¶
Gets the type of this DarcyForchheimerMedium. # noqa: E501
Schema name: DarcyForchheimerMedium # noqa: E501
- Returns
The type of this DarcyForchheimerMedium. # noqa: E501
- Return type
str
simscale_sdk.models.data_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.data_type.DataType(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- CELL = 'CELL'¶
- POINT = 'POINT'¶
- allowable_values = ['POINT', 'CELL']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.debug_mesh_sizing_simmetrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.debug_mesh_sizing_simmetrix.DebugMeshSizingSimmetrix(type='DEBUG', maximum_edge_length=None, minimum_edge_length=None, chordal_error=None, min_curv_ref=None, gradation_rate=None, prox_ref_factor=None, min_prox_size=None, small_feature_tol=None, layer_adjustment_behaviour=None, layer_height_gradation_rate=None, surf_skewness=None, vol_len_ratio=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'chordal_error': 'chordalError', 'gradation_rate': 'gradationRate', 'layer_adjustment_behaviour': 'layerAdjustmentBehaviour', 'layer_height_gradation_rate': 'layerHeightGradationRate', 'maximum_edge_length': 'maximumEdgeLength', 'min_curv_ref': 'minCurvRef', 'min_prox_size': 'minProxSize', 'minimum_edge_length': 'minimumEdgeLength', 'prox_ref_factor': 'proxRefFactor', 'small_feature_tol': 'smallFeatureTol', 'surf_skewness': 'surfSkewness', 'type': 'type', 'vol_len_ratio': 'volLenRatio'}¶
- property chordal_error¶
Gets the chordal_error of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The chordal_error of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- property gradation_rate¶
Gets the gradation_rate of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The gradation_rate of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- property layer_adjustment_behaviour¶
Gets the layer_adjustment_behaviour of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The layer_adjustment_behaviour of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
str
- property layer_height_gradation_rate¶
Gets the layer_height_gradation_rate of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The layer_height_gradation_rate of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- property maximum_edge_length¶
Gets the maximum_edge_length of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The maximum_edge_length of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
- property min_curv_ref¶
Gets the min_curv_ref of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The min_curv_ref of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- property min_prox_size¶
Gets the min_prox_size of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The min_prox_size of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
- property minimum_edge_length¶
Gets the minimum_edge_length of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The minimum_edge_length of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
- openapi_types = {'chordal_error': 'float', 'gradation_rate': 'float', 'layer_adjustment_behaviour': 'str', 'layer_height_gradation_rate': 'float', 'maximum_edge_length': 'DimensionalLength', 'min_curv_ref': 'float', 'min_prox_size': 'DimensionalLength', 'minimum_edge_length': 'DimensionalLength', 'prox_ref_factor': 'float', 'small_feature_tol': 'float', 'surf_skewness': 'float', 'type': 'str', 'vol_len_ratio': 'float'}¶
- property prox_ref_factor¶
Gets the prox_ref_factor of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The prox_ref_factor of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- property small_feature_tol¶
Gets the small_feature_tol of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The small_feature_tol of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- property surf_skewness¶
Gets the surf_skewness of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The surf_skewness of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DebugMeshSizingSimmetrix. # noqa: E501
Schema name: DebugMeshSizingSimmetrix # noqa: E501
- Returns
The type of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
str
- property vol_len_ratio¶
Gets the vol_len_ratio of this DebugMeshSizingSimmetrix. # noqa: E501
- Returns
The vol_len_ratio of this DebugMeshSizingSimmetrix. # noqa: E501
- Return type
float
simscale_sdk.models.decimal_vector module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.decimal_vector.DecimalVector(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'x': 'float', 'y': 'float', 'z': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this DecimalVector. # noqa: E501
- Returns
The x of this DecimalVector. # noqa: E501
- Return type
float
- property y¶
Gets the y of this DecimalVector. # noqa: E501
- Returns
The y of this DecimalVector. # noqa: E501
- Return type
float
- property z¶
Gets the z of this DecimalVector. # noqa: E501
- Returns
The z of this DecimalVector. # noqa: E501
- Return type
float
simscale_sdk.models.decimal_vector2d module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.decimal_vector2d.DecimalVector2d(x=None, y=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y'}¶
- openapi_types = {'x': 'float', 'y': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this DecimalVector2d. # noqa: E501
- Returns
The x of this DecimalVector2d. # noqa: E501
- Return type
float
- property y¶
Gets the y of this DecimalVector2d. # noqa: E501
- Returns
The y of this DecimalVector2d. # noqa: E501
- Return type
float
simscale_sdk.models.derived_heat_flux module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.derived_heat_flux.DerivedHeatFlux(type='DERIVED', heat_transfer_coefficient=None, ambient_temperature=None, additional_heat_flux=None, wall_thermal=None, outer_surface_emissivity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property additional_heat_flux¶
Gets the additional_heat_flux of this DerivedHeatFlux. # noqa: E501
- Returns
The additional_heat_flux of this DerivedHeatFlux. # noqa: E501
- Return type
- property ambient_temperature¶
Gets the ambient_temperature of this DerivedHeatFlux. # noqa: E501
- Returns
The ambient_temperature of this DerivedHeatFlux. # noqa: E501
- Return type
- attribute_map = {'additional_heat_flux': 'additionalHeatFlux', 'ambient_temperature': 'ambientTemperature', 'heat_transfer_coefficient': 'heatTransferCoefficient', 'outer_surface_emissivity': 'outerSurfaceEmissivity', 'type': 'type', 'wall_thermal': 'wallThermal'}¶
- property heat_transfer_coefficient¶
Gets the heat_transfer_coefficient of this DerivedHeatFlux. # noqa: E501
- Returns
The heat_transfer_coefficient of this DerivedHeatFlux. # noqa: E501
- Return type
- openapi_types = {'additional_heat_flux': 'DimensionalHeatFlux', 'ambient_temperature': 'DimensionalTemperature', 'heat_transfer_coefficient': 'DimensionalThermalTransmittance', 'outer_surface_emissivity': 'float', 'type': 'str', 'wall_thermal': 'OneOfDerivedHeatFluxWallThermal'}¶
- property outer_surface_emissivity¶
Gets the outer_surface_emissivity of this DerivedHeatFlux. # noqa: E501
Emissivity/Absorptivity of the outer side of the surface or the last wall thermal layer. # noqa: E501
- Returns
The outer_surface_emissivity of this DerivedHeatFlux. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DerivedHeatFlux. # noqa: E501
Schema name: DerivedHeatFlux # noqa: E501
- Returns
The type of this DerivedHeatFlux. # noqa: E501
- Return type
str
- property wall_thermal¶
Gets the wall_thermal of this DerivedHeatFlux. # noqa: E501
- Returns
The wall_thermal of this DerivedHeatFlux. # noqa: E501
- Return type
OneOfDerivedHeatFluxWallThermal
simscale_sdk.models.dic_preconditioner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dic_preconditioner.DICPreconditioner(type='DIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DICPreconditioner. # noqa: E501
Diagonal incomplete Cholesky algorithm for symmetric matrices without fill-in. Schema name: DICPreconditioner # noqa: E501
- Returns
The type of this DICPreconditioner. # noqa: E501
- Return type
str
simscale_sdk.models.dilu_preconditioner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dilu_preconditioner.DILUPreconditioner(type='DILU', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DILUPreconditioner. # noqa: E501
Diagonal incomplete lower-upper (ILU) algorithm for non-symmetric matrices without fill-in. Schema name: DILUPreconditioner # noqa: E501
- Returns
The type of this DILUPreconditioner. # noqa: E501
- Return type
str
simscale_sdk.models.dimensional_absorptivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_absorptivity.DimensionalAbsorptivity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalAbsorptivity. # noqa: E501
- Returns
The unit of this DimensionalAbsorptivity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalAbsorptivity. # noqa: E501
- Returns
The value of this DimensionalAbsorptivity. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_acceleration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_acceleration.DimensionalAcceleration(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalAcceleration. # noqa: E501
- Returns
The unit of this DimensionalAcceleration. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalAcceleration. # noqa: E501
- Returns
The value of this DimensionalAcceleration. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_amount_of_substance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_amount_of_substance.DimensionalAmountOfSubstance(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalAmountOfSubstance. # noqa: E501
- Returns
The unit of this DimensionalAmountOfSubstance. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalAmountOfSubstance. # noqa: E501
- Returns
The value of this DimensionalAmountOfSubstance. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_angle module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_angle.DimensionalAngle(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalAngle. # noqa: E501
- Returns
The unit of this DimensionalAngle. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalAngle. # noqa: E501
- Returns
The value of this DimensionalAngle. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_area module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_area.DimensionalArea(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalArea. # noqa: E501
- Returns
The unit of this DimensionalArea. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalArea. # noqa: E501
- Returns
The value of this DimensionalArea. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_contact_resistance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_contact_resistance.DimensionalContactResistance(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalContactResistance. # noqa: E501
- Returns
The unit of this DimensionalContactResistance. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalContactResistance. # noqa: E501
- Returns
The value of this DimensionalContactResistance. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_density module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_density.DimensionalDensity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalDensity. # noqa: E501
- Returns
The unit of this DimensionalDensity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalDensity. # noqa: E501
- Returns
The value of this DimensionalDensity. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_dimensionless module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_dimensionless.DimensionalDimensionless(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalDimensionless. # noqa: E501
- Returns
The unit of this DimensionalDimensionless. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalDimensionless. # noqa: E501
- Returns
The value of this DimensionalDimensionless. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_dynamic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_dynamic_viscosity.DimensionalDynamicViscosity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalDynamicViscosity. # noqa: E501
- Returns
The unit of this DimensionalDynamicViscosity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalDynamicViscosity. # noqa: E501
- Returns
The value of this DimensionalDynamicViscosity. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_eddy_viscosity_gradient module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_eddy_viscosity_gradient.DimensionalEddyViscosityGradient(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalEddyViscosityGradient. # noqa: E501
- Returns
The unit of this DimensionalEddyViscosityGradient. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalEddyViscosityGradient. # noqa: E501
- Returns
The value of this DimensionalEddyViscosityGradient. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_epsilon_gradient module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_epsilon_gradient.DimensionalEpsilonGradient(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalEpsilonGradient. # noqa: E501
- Returns
The unit of this DimensionalEpsilonGradient. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalEpsilonGradient. # noqa: E501
- Returns
The value of this DimensionalEpsilonGradient. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_force module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_force.DimensionalForce(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalForce. # noqa: E501
- Returns
The unit of this DimensionalForce. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalForce. # noqa: E501
- Returns
The value of this DimensionalForce. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_force_density module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_force_density.DimensionalForceDensity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalForceDensity. # noqa: E501
- Returns
The unit of this DimensionalForceDensity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalForceDensity. # noqa: E501
- Returns
The value of this DimensionalForceDensity. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_frequency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_frequency.DimensionalFrequency(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFrequency. # noqa: E501
- Returns
The unit of this DimensionalFrequency. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFrequency. # noqa: E501
- Returns
The value of this DimensionalFrequency. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_friction_augmentation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_friction_augmentation.DimensionalFrictionAugmentation(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFrictionAugmentation. # noqa: E501
- Returns
The unit of this DimensionalFrictionAugmentation. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFrictionAugmentation. # noqa: E501
- Returns
The value of this DimensionalFrictionAugmentation. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_function_acceleration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_acceleration.DimensionalFunctionAcceleration(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionAccelerationValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionAcceleration. # noqa: E501
- Returns
The unit of this DimensionalFunctionAcceleration. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionAcceleration. # noqa: E501
- Returns
The value of this DimensionalFunctionAcceleration. # noqa: E501
- Return type
OneOfDimensionalFunctionAccelerationValue
simscale_sdk.models.dimensional_function_angle module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_angle.DimensionalFunctionAngle(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionAngleValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionAngle. # noqa: E501
- Returns
The unit of this DimensionalFunctionAngle. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionAngle. # noqa: E501
- Returns
The value of this DimensionalFunctionAngle. # noqa: E501
- Return type
OneOfDimensionalFunctionAngleValue
simscale_sdk.models.dimensional_function_density module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_density.DimensionalFunctionDensity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionDensityValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionDensity. # noqa: E501
- Returns
The unit of this DimensionalFunctionDensity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionDensity. # noqa: E501
- Returns
The value of this DimensionalFunctionDensity. # noqa: E501
- Return type
OneOfDimensionalFunctionDensityValue
simscale_sdk.models.dimensional_function_dimensionless module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_dimensionless.DimensionalFunctionDimensionless(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionDimensionlessValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionDimensionless. # noqa: E501
- Returns
The unit of this DimensionalFunctionDimensionless. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionDimensionless. # noqa: E501
- Returns
The value of this DimensionalFunctionDimensionless. # noqa: E501
- Return type
OneOfDimensionalFunctionDimensionlessValue
simscale_sdk.models.dimensional_function_dynamic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_dynamic_viscosity.DimensionalFunctionDynamicViscosity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionDynamicViscosityValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionDynamicViscosity. # noqa: E501
- Returns
The unit of this DimensionalFunctionDynamicViscosity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionDynamicViscosity. # noqa: E501
- Returns
The value of this DimensionalFunctionDynamicViscosity. # noqa: E501
- Return type
OneOfDimensionalFunctionDynamicViscosityValue
simscale_sdk.models.dimensional_function_heat_flux module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_heat_flux.DimensionalFunctionHeatFlux(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionHeatFluxValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionHeatFlux. # noqa: E501
- Returns
The unit of this DimensionalFunctionHeatFlux. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionHeatFlux. # noqa: E501
- Returns
The value of this DimensionalFunctionHeatFlux. # noqa: E501
- Return type
OneOfDimensionalFunctionHeatFluxValue
simscale_sdk.models.dimensional_function_initial_condition_domains_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_initial_condition_domains_temperature.DimensionalFunctionInitialConditionDomainsTemperature(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalFunctionTemperature', 'subdomains': 'list[SubdomainDimensionalFunctionInitialConditionTemperature]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalFunctionInitialConditionDomainsTemperature. # noqa: E501
- Returns
The subdomains of this DimensionalFunctionInitialConditionDomainsTemperature. # noqa: E501
- Return type
list[SubdomainDimensionalFunctionInitialConditionTemperature]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_function_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_length.DimensionalFunctionLength(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionLengthValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionLength. # noqa: E501
- Returns
The unit of this DimensionalFunctionLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionLength. # noqa: E501
- Returns
The value of this DimensionalFunctionLength. # noqa: E501
- Return type
OneOfDimensionalFunctionLengthValue
simscale_sdk.models.dimensional_function_mass_flow_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_mass_flow_rate.DimensionalFunctionMassFlowRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionMassFlowRateValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionMassFlowRate. # noqa: E501
- Returns
The unit of this DimensionalFunctionMassFlowRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionMassFlowRate. # noqa: E501
- Returns
The value of this DimensionalFunctionMassFlowRate. # noqa: E501
- Return type
OneOfDimensionalFunctionMassFlowRateValue
simscale_sdk.models.dimensional_function_power module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_power.DimensionalFunctionPower(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionPowerValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionPower. # noqa: E501
- Returns
The unit of this DimensionalFunctionPower. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionPower. # noqa: E501
- Returns
The value of this DimensionalFunctionPower. # noqa: E501
- Return type
OneOfDimensionalFunctionPowerValue
simscale_sdk.models.dimensional_function_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_pressure.DimensionalFunctionPressure(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionPressureValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionPressure. # noqa: E501
- Returns
The unit of this DimensionalFunctionPressure. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionPressure. # noqa: E501
- Returns
The value of this DimensionalFunctionPressure. # noqa: E501
- Return type
OneOfDimensionalFunctionPressureValue
simscale_sdk.models.dimensional_function_rotation_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_rotation_speed.DimensionalFunctionRotationSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionRotationSpeedValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionRotationSpeed. # noqa: E501
- Returns
The unit of this DimensionalFunctionRotationSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionRotationSpeed. # noqa: E501
- Returns
The value of this DimensionalFunctionRotationSpeed. # noqa: E501
- Return type
OneOfDimensionalFunctionRotationSpeedValue
simscale_sdk.models.dimensional_function_specific_heat module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_specific_heat.DimensionalFunctionSpecificHeat(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionSpecificHeatValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionSpecificHeat. # noqa: E501
- Returns
The unit of this DimensionalFunctionSpecificHeat. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionSpecificHeat. # noqa: E501
- Returns
The value of this DimensionalFunctionSpecificHeat. # noqa: E501
- Return type
OneOfDimensionalFunctionSpecificHeatValue
simscale_sdk.models.dimensional_function_specific_turbulence_dissipation_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_specific_turbulence_dissipation_rate.DimensionalFunctionSpecificTurbulenceDissipationRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionSpecificTurbulenceDissipationRateValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The unit of this DimensionalFunctionSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The value of this DimensionalFunctionSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
OneOfDimensionalFunctionSpecificTurbulenceDissipationRateValue
simscale_sdk.models.dimensional_function_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_speed.DimensionalFunctionSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionSpeedValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionSpeed. # noqa: E501
- Returns
The unit of this DimensionalFunctionSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionSpeed. # noqa: E501
- Returns
The value of this DimensionalFunctionSpeed. # noqa: E501
- Return type
OneOfDimensionalFunctionSpeedValue
simscale_sdk.models.dimensional_function_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_temperature.DimensionalFunctionTemperature(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionTemperatureValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionTemperature. # noqa: E501
- Returns
The unit of this DimensionalFunctionTemperature. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionTemperature. # noqa: E501
- Returns
The value of this DimensionalFunctionTemperature. # noqa: E501
- Return type
OneOfDimensionalFunctionTemperatureValue
simscale_sdk.models.dimensional_function_temperature_gradient module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_temperature_gradient.DimensionalFunctionTemperatureGradient(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionTemperatureGradientValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionTemperatureGradient. # noqa: E501
- Returns
The unit of this DimensionalFunctionTemperatureGradient. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionTemperatureGradient. # noqa: E501
- Returns
The value of this DimensionalFunctionTemperatureGradient. # noqa: E501
- Return type
OneOfDimensionalFunctionTemperatureGradientValue
simscale_sdk.models.dimensional_function_thermal_conductivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_thermal_conductivity.DimensionalFunctionThermalConductivity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionThermalConductivityValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionThermalConductivity. # noqa: E501
- Returns
The unit of this DimensionalFunctionThermalConductivity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionThermalConductivity. # noqa: E501
- Returns
The value of this DimensionalFunctionThermalConductivity. # noqa: E501
- Return type
OneOfDimensionalFunctionThermalConductivityValue
simscale_sdk.models.dimensional_function_thermal_expansion_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_thermal_expansion_rate.DimensionalFunctionThermalExpansionRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionThermalExpansionRateValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionThermalExpansionRate. # noqa: E501
- Returns
The unit of this DimensionalFunctionThermalExpansionRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionThermalExpansionRate. # noqa: E501
- Returns
The value of this DimensionalFunctionThermalExpansionRate. # noqa: E501
- Return type
OneOfDimensionalFunctionThermalExpansionRateValue
simscale_sdk.models.dimensional_function_thermal_transmittance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_thermal_transmittance.DimensionalFunctionThermalTransmittance(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionThermalTransmittanceValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionThermalTransmittance. # noqa: E501
- Returns
The unit of this DimensionalFunctionThermalTransmittance. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionThermalTransmittance. # noqa: E501
- Returns
The value of this DimensionalFunctionThermalTransmittance. # noqa: E501
- Return type
OneOfDimensionalFunctionThermalTransmittanceValue
simscale_sdk.models.dimensional_function_turbulence_kinetic_energy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_turbulence_kinetic_energy.DimensionalFunctionTurbulenceKineticEnergy(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionTurbulenceKineticEnergyValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionTurbulenceKineticEnergy. # noqa: E501
- Returns
The unit of this DimensionalFunctionTurbulenceKineticEnergy. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionTurbulenceKineticEnergy. # noqa: E501
- Returns
The value of this DimensionalFunctionTurbulenceKineticEnergy. # noqa: E501
- Return type
OneOfDimensionalFunctionTurbulenceKineticEnergyValue
simscale_sdk.models.dimensional_function_turbulent_dissipation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_turbulent_dissipation.DimensionalFunctionTurbulentDissipation(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionTurbulentDissipationValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionTurbulentDissipation. # noqa: E501
- Returns
The unit of this DimensionalFunctionTurbulentDissipation. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionTurbulentDissipation. # noqa: E501
- Returns
The value of this DimensionalFunctionTurbulentDissipation. # noqa: E501
- Return type
OneOfDimensionalFunctionTurbulentDissipationValue
simscale_sdk.models.dimensional_function_volumetric_flow_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_volumetric_flow_rate.DimensionalFunctionVolumetricFlowRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionVolumetricFlowRateValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionVolumetricFlowRate. # noqa: E501
- Returns
The unit of this DimensionalFunctionVolumetricFlowRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionVolumetricFlowRate. # noqa: E501
- Returns
The value of this DimensionalFunctionVolumetricFlowRate. # noqa: E501
- Return type
OneOfDimensionalFunctionVolumetricFlowRateValue
simscale_sdk.models.dimensional_function_volumetric_power module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_function_volumetric_power.DimensionalFunctionVolumetricPower(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalFunctionVolumetricPowerValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalFunctionVolumetricPower. # noqa: E501
- Returns
The unit of this DimensionalFunctionVolumetricPower. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalFunctionVolumetricPower. # noqa: E501
- Returns
The value of this DimensionalFunctionVolumetricPower. # noqa: E501
- Return type
OneOfDimensionalFunctionVolumetricPowerValue
simscale_sdk.models.dimensional_heat_flux module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_heat_flux.DimensionalHeatFlux(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalHeatFlux. # noqa: E501
- Returns
The unit of this DimensionalHeatFlux. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalHeatFlux. # noqa: E501
- Returns
The value of this DimensionalHeatFlux. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_initial_condition_domains_dimensionless module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_dimensionless.DimensionalInitialConditionDomainsDimensionless(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalDimensionless', 'subdomains': 'list[SubdomainDimensionalInitialConditionDimensionless]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsDimensionless. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsDimensionless. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_dynamic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_dynamic_viscosity.DimensionalInitialConditionDomainsDynamicViscosity(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalDynamicViscosity', 'subdomains': 'list[SubdomainDimensionalInitialConditionDynamicViscosity]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsDynamicViscosity. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsDynamicViscosity. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_kinematic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_kinematic_viscosity.DimensionalInitialConditionDomainsKinematicViscosity(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalKinematicViscosity', 'subdomains': 'list[SubdomainDimensionalInitialConditionKinematicViscosity]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsKinematicViscosity. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsKinematicViscosity. # noqa: E501
- Return type
list[SubdomainDimensionalInitialConditionKinematicViscosity]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_pressure.DimensionalInitialConditionDomainsPressure(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalPressure', 'subdomains': 'list[SubdomainDimensionalInitialConditionPressure]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsPressure. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsPressure. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_specific_turbulence_dissipation_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_specific_turbulence_dissipation_rate.DimensionalInitialConditionDomainsSpecificTurbulenceDissipationRate(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalSpecificTurbulenceDissipationRate', 'subdomains': 'list[SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
list[SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_temperature.DimensionalInitialConditionDomainsTemperature(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalTemperature', 'subdomains': 'list[SubdomainDimensionalInitialConditionTemperature]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsTemperature. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsTemperature. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_turbulence_kinetic_energy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_turbulence_kinetic_energy.DimensionalInitialConditionDomainsTurbulenceKineticEnergy(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalTurbulenceKineticEnergy', 'subdomains': 'list[SubdomainDimensionalInitialConditionTurbulenceKineticEnergy]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsTurbulenceKineticEnergy. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsTurbulenceKineticEnergy. # noqa: E501
- Return type
list[SubdomainDimensionalInitialConditionTurbulenceKineticEnergy]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_initial_condition_domains_turbulent_dissipation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_initial_condition_domains_turbulent_dissipation.DimensionalInitialConditionDomainsTurbulentDissipation(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalTurbulentDissipation', 'subdomains': 'list[SubdomainDimensionalInitialConditionTurbulentDissipation]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalInitialConditionDomainsTurbulentDissipation. # noqa: E501
- Returns
The subdomains of this DimensionalInitialConditionDomainsTurbulentDissipation. # noqa: E501
- Return type
list[SubdomainDimensionalInitialConditionTurbulentDissipation]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_inv_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_inv_pressure.DimensionalInvPressure(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalInvPressure. # noqa: E501
- Returns
The unit of this DimensionalInvPressure. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalInvPressure. # noqa: E501
- Returns
The value of this DimensionalInvPressure. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_kinematic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_kinematic_viscosity.DimensionalKinematicViscosity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalKinematicViscosity. # noqa: E501
- Returns
The unit of this DimensionalKinematicViscosity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalKinematicViscosity. # noqa: E501
- Returns
The value of this DimensionalKinematicViscosity. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_length.DimensionalLength(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalLength. # noqa: E501
- Returns
The unit of this DimensionalLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalLength. # noqa: E501
- Returns
The value of this DimensionalLength. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_mass module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_mass.DimensionalMass(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalMass. # noqa: E501
- Returns
The unit of this DimensionalMass. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalMass. # noqa: E501
- Returns
The value of this DimensionalMass. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_molar_mass module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_molar_mass.DimensionalMolarMass(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalMolarMass. # noqa: E501
- Returns
The unit of this DimensionalMolarMass. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalMolarMass. # noqa: E501
- Returns
The value of this DimensionalMolarMass. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_partial_vector_function_angle module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_partial_vector_function_angle.DimensionalPartialVectorFunctionAngle(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'PartialVectorFunction'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalPartialVectorFunctionAngle. # noqa: E501
- Returns
The unit of this DimensionalPartialVectorFunctionAngle. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalPartialVectorFunctionAngle. # noqa: E501
- Returns
The value of this DimensionalPartialVectorFunctionAngle. # noqa: E501
- Return type
simscale_sdk.models.dimensional_partial_vector_function_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_partial_vector_function_length.DimensionalPartialVectorFunctionLength(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'PartialVectorFunction'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalPartialVectorFunctionLength. # noqa: E501
- Returns
The unit of this DimensionalPartialVectorFunctionLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalPartialVectorFunctionLength. # noqa: E501
- Returns
The value of this DimensionalPartialVectorFunctionLength. # noqa: E501
- Return type
simscale_sdk.models.dimensional_passive_scalar_source_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_passive_scalar_source_rate.DimensionalPassiveScalarSourceRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalPassiveScalarSourceRate. # noqa: E501
- Returns
The unit of this DimensionalPassiveScalarSourceRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalPassiveScalarSourceRate. # noqa: E501
- Returns
The value of this DimensionalPassiveScalarSourceRate. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_phase_fraction_gradient module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_phase_fraction_gradient.DimensionalPhaseFractionGradient(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalPhaseFractionGradient. # noqa: E501
- Returns
The unit of this DimensionalPhaseFractionGradient. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalPhaseFractionGradient. # noqa: E501
- Returns
The value of this DimensionalPhaseFractionGradient. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_power module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_power.DimensionalPower(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalPower. # noqa: E501
- Returns
The unit of this DimensionalPower. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalPower. # noqa: E501
- Returns
The value of this DimensionalPower. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_pressure.DimensionalPressure(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalPressure. # noqa: E501
- Returns
The unit of this DimensionalPressure. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalPressure. # noqa: E501
- Returns
The value of this DimensionalPressure. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_rotation_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_rotation_speed.DimensionalRotationSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalRotationSpeed. # noqa: E501
- Returns
The unit of this DimensionalRotationSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalRotationSpeed. # noqa: E501
- Returns
The value of this DimensionalRotationSpeed. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_specific_heat module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_specific_heat.DimensionalSpecificHeat(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalSpecificHeat. # noqa: E501
- Returns
The unit of this DimensionalSpecificHeat. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalSpecificHeat. # noqa: E501
- Returns
The value of this DimensionalSpecificHeat. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_specific_turbulence_dissipation_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_specific_turbulence_dissipation_rate.DimensionalSpecificTurbulenceDissipationRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The unit of this DimensionalSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The value of this DimensionalSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_specific_turbulence_dissipation_rate_gradient module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_specific_turbulence_dissipation_rate_gradient.DimensionalSpecificTurbulenceDissipationRateGradient(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalSpecificTurbulenceDissipationRateGradient. # noqa: E501
- Returns
The unit of this DimensionalSpecificTurbulenceDissipationRateGradient. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalSpecificTurbulenceDissipationRateGradient. # noqa: E501
- Returns
The value of this DimensionalSpecificTurbulenceDissipationRateGradient. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_speed.DimensionalSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalSpeed. # noqa: E501
- Returns
The unit of this DimensionalSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalSpeed. # noqa: E501
- Returns
The value of this DimensionalSpeed. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_strain_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_strain_rate.DimensionalStrainRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalStrainRate. # noqa: E501
- Returns
The unit of this DimensionalStrainRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalStrainRate. # noqa: E501
- Returns
The value of this DimensionalStrainRate. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_surface_tension module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_surface_tension.DimensionalSurfaceTension(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalSurfaceTension. # noqa: E501
- Returns
The unit of this DimensionalSurfaceTension. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalSurfaceTension. # noqa: E501
- Returns
The value of this DimensionalSurfaceTension. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_temperature.DimensionalTemperature(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalTemperature. # noqa: E501
- Returns
The unit of this DimensionalTemperature. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalTemperature. # noqa: E501
- Returns
The value of this DimensionalTemperature. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_thermal_conductivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_thermal_conductivity.DimensionalThermalConductivity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalThermalConductivity. # noqa: E501
- Returns
The unit of this DimensionalThermalConductivity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalThermalConductivity. # noqa: E501
- Returns
The value of this DimensionalThermalConductivity. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_thermal_expansion_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_thermal_expansion_rate.DimensionalThermalExpansionRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalThermalExpansionRate. # noqa: E501
- Returns
The unit of this DimensionalThermalExpansionRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalThermalExpansionRate. # noqa: E501
- Returns
The value of this DimensionalThermalExpansionRate. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_thermal_transmittance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_thermal_transmittance.DimensionalThermalTransmittance(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalThermalTransmittance. # noqa: E501
- Returns
The unit of this DimensionalThermalTransmittance. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalThermalTransmittance. # noqa: E501
- Returns
The value of this DimensionalThermalTransmittance. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_time module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_time.DimensionalTime(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalTime. # noqa: E501
- Returns
The unit of this DimensionalTime. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalTime. # noqa: E501
- Returns
The value of this DimensionalTime. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_turbulence_kinetic_energy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_turbulence_kinetic_energy.DimensionalTurbulenceKineticEnergy(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalTurbulenceKineticEnergy. # noqa: E501
- Returns
The unit of this DimensionalTurbulenceKineticEnergy. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalTurbulenceKineticEnergy. # noqa: E501
- Returns
The value of this DimensionalTurbulenceKineticEnergy. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_turbulent_dissipation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_turbulent_dissipation.DimensionalTurbulentDissipation(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalTurbulentDissipation. # noqa: E501
- Returns
The unit of this DimensionalTurbulentDissipation. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalTurbulentDissipation. # noqa: E501
- Returns
The value of this DimensionalTurbulentDissipation. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_vector2d_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector2d_length.DimensionalVector2dLength(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector2d'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVector2dLength. # noqa: E501
- Returns
The unit of this DimensionalVector2dLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVector2dLength. # noqa: E501
- Returns
The value of this DimensionalVector2dLength. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_absorptivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_absorptivity.DimensionalVectorAbsorptivity(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorAbsorptivity. # noqa: E501
- Returns
The unit of this DimensionalVectorAbsorptivity. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorAbsorptivity. # noqa: E501
- Returns
The value of this DimensionalVectorAbsorptivity. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_acceleration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_acceleration.DimensionalVectorAcceleration(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorAcceleration. # noqa: E501
- Returns
The unit of this DimensionalVectorAcceleration. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorAcceleration. # noqa: E501
- Returns
The value of this DimensionalVectorAcceleration. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_angle module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_angle.DimensionalVectorAngle(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorAngle. # noqa: E501
- Returns
The unit of this DimensionalVectorAngle. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorAngle. # noqa: E501
- Returns
The value of this DimensionalVectorAngle. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_dimensionless module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_dimensionless.DimensionalVectorDimensionless(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorDimensionless. # noqa: E501
- Returns
The unit of this DimensionalVectorDimensionless. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorDimensionless. # noqa: E501
- Returns
The value of this DimensionalVectorDimensionless. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_function_acceleration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_acceleration.DimensionalVectorFunctionAcceleration(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionAccelerationValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionAcceleration. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionAcceleration. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionAcceleration. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionAcceleration. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionAccelerationValue
simscale_sdk.models.dimensional_vector_function_force module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_force.DimensionalVectorFunctionForce(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionForceValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionForce. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionForce. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionForce. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionForce. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionForceValue
simscale_sdk.models.dimensional_vector_function_initial_condition_with_domains_acceleration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_initial_condition_with_domains_acceleration.DimensionalVectorFunctionInitialConditionWithDomainsAcceleration(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalVectorFunctionAcceleration', 'subdomains': 'list[SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalVectorFunctionInitialConditionWithDomainsAcceleration. # noqa: E501
- Returns
The subdomains of this DimensionalVectorFunctionInitialConditionWithDomainsAcceleration. # noqa: E501
- Return type
list[SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_vector_function_initial_condition_with_domains_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_initial_condition_with_domains_length.DimensionalVectorFunctionInitialConditionWithDomainsLength(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalVectorFunctionLength', 'subdomains': 'list[SubdomainBasedDimensionalVectorFunctionInitialConditionLength]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalVectorFunctionInitialConditionWithDomainsLength. # noqa: E501
- Returns
The subdomains of this DimensionalVectorFunctionInitialConditionWithDomainsLength. # noqa: E501
- Return type
list[SubdomainBasedDimensionalVectorFunctionInitialConditionLength]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_vector_function_initial_condition_with_domains_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_initial_condition_with_domains_speed.DimensionalVectorFunctionInitialConditionWithDomainsSpeed(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalVectorFunctionSpeed', 'subdomains': 'list[SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalVectorFunctionInitialConditionWithDomainsSpeed. # noqa: E501
- Returns
The subdomains of this DimensionalVectorFunctionInitialConditionWithDomainsSpeed. # noqa: E501
- Return type
list[SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_vector_function_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_length.DimensionalVectorFunctionLength(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionLengthValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionLength. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionLength. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionLength. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionLengthValue
simscale_sdk.models.dimensional_vector_function_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_pressure.DimensionalVectorFunctionPressure(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionPressureValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionPressure. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionPressure. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionPressure. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionPressure. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionPressureValue
simscale_sdk.models.dimensional_vector_function_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_speed.DimensionalVectorFunctionSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionSpeedValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionSpeed. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionSpeed. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionSpeed. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionSpeedValue
simscale_sdk.models.dimensional_vector_function_torque module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_torque.DimensionalVectorFunctionTorque(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionTorqueValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionTorque. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionTorque. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionTorque. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionTorque. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionTorqueValue
simscale_sdk.models.dimensional_vector_function_volume_force module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_function_volume_force.DimensionalVectorFunctionVolumeForce(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfDimensionalVectorFunctionVolumeForceValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorFunctionVolumeForce. # noqa: E501
- Returns
The unit of this DimensionalVectorFunctionVolumeForce. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorFunctionVolumeForce. # noqa: E501
- Returns
The value of this DimensionalVectorFunctionVolumeForce. # noqa: E501
- Return type
OneOfDimensionalVectorFunctionVolumeForceValue
simscale_sdk.models.dimensional_vector_initial_condition_domains_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_initial_condition_domains_speed.DimensionalVectorInitialConditionDomainsSpeed(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'DimensionalVectorSpeed', 'subdomains': 'list[SubdomainDimensionalVectorInitialConditionSpeed]'}¶
- property subdomains¶
Gets the subdomains of this DimensionalVectorInitialConditionDomainsSpeed. # noqa: E501
- Returns
The subdomains of this DimensionalVectorInitialConditionDomainsSpeed. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.dimensional_vector_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_length.DimensionalVectorLength(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorLength. # noqa: E501
- Returns
The unit of this DimensionalVectorLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorLength. # noqa: E501
- Returns
The value of this DimensionalVectorLength. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_moment_of_inertia module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_moment_of_inertia.DimensionalVectorMomentOfInertia(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorMomentOfInertia. # noqa: E501
- Returns
The unit of this DimensionalVectorMomentOfInertia. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorMomentOfInertia. # noqa: E501
- Returns
The value of this DimensionalVectorMomentOfInertia. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_reciprocal_permeability module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_reciprocal_permeability.DimensionalVectorReciprocalPermeability(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorReciprocalPermeability. # noqa: E501
- Returns
The unit of this DimensionalVectorReciprocalPermeability. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorReciprocalPermeability. # noqa: E501
- Returns
The value of this DimensionalVectorReciprocalPermeability. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_rotation_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_rotation_speed.DimensionalVectorRotationSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorRotationSpeed. # noqa: E501
- Returns
The unit of this DimensionalVectorRotationSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorRotationSpeed. # noqa: E501
- Returns
The value of this DimensionalVectorRotationSpeed. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_specific_turbulence_dissipation_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_specific_turbulence_dissipation_rate.DimensionalVectorSpecificTurbulenceDissipationRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The unit of this DimensionalVectorSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The value of this DimensionalVectorSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_speed.DimensionalVectorSpeed(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorSpeed. # noqa: E501
- Returns
The unit of this DimensionalVectorSpeed. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorSpeed. # noqa: E501
- Returns
The value of this DimensionalVectorSpeed. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_surface_tension module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_surface_tension.DimensionalVectorSurfaceTension(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorSurfaceTension. # noqa: E501
- Returns
The unit of this DimensionalVectorSurfaceTension. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorSurfaceTension. # noqa: E501
- Returns
The value of this DimensionalVectorSurfaceTension. # noqa: E501
- Return type
simscale_sdk.models.dimensional_vector_volume_force module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_vector_volume_force.DimensionalVectorVolumeForce(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'DecimalVector'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVectorVolumeForce. # noqa: E501
- Returns
The unit of this DimensionalVectorVolumeForce. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVectorVolumeForce. # noqa: E501
- Returns
The value of this DimensionalVectorVolumeForce. # noqa: E501
- Return type
simscale_sdk.models.dimensional_volume module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_volume.DimensionalVolume(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVolume. # noqa: E501
- Returns
The unit of this DimensionalVolume. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVolume. # noqa: E501
- Returns
The value of this DimensionalVolume. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_volume_force module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_volume_force.DimensionalVolumeForce(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVolumeForce. # noqa: E501
- Returns
The unit of this DimensionalVolumeForce. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVolumeForce. # noqa: E501
- Returns
The value of this DimensionalVolumeForce. # noqa: E501
- Return type
float
simscale_sdk.models.dimensional_volumetric_passive_scalar_source_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dimensional_volumetric_passive_scalar_source_rate.DimensionalVolumetricPassiveScalarSourceRate(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this DimensionalVolumetricPassiveScalarSourceRate. # noqa: E501
- Returns
The unit of this DimensionalVolumetricPassiveScalarSourceRate. # noqa: E501
- Return type
str
- property value¶
Gets the value of this DimensionalVolumetricPassiveScalarSourceRate. # noqa: E501
- Returns
The value of this DimensionalVolumetricPassiveScalarSourceRate. # noqa: E501
- Return type
float
simscale_sdk.models.directional_dependency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.directional_dependency.DirectionalDependency(darcy_forchheimer_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'darcy_forchheimer_type': 'darcyForchheimerType'}¶
- property darcy_forchheimer_type¶
Gets the darcy_forchheimer_type of this DirectionalDependency. # noqa: E501
- Returns
The darcy_forchheimer_type of this DirectionalDependency. # noqa: E501
- Return type
OneOfDirectionalDependencyDarcyForchheimerType
- openapi_types = {'darcy_forchheimer_type': 'OneOfDirectionalDependencyDarcyForchheimerType'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.displacement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.displacement.Displacement(field=None, scale_factor=1.0, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field': 'field', 'scale_factor': 'scaleFactor'}¶
- property field¶
Gets the field of this Displacement. # noqa: E501
- Returns
The field of this Displacement. # noqa: E501
- Return type
- openapi_types = {'field': 'VectorField', 'scale_factor': 'float'}¶
- property scale_factor¶
Gets the scale_factor of this Displacement. # noqa: E501
- Returns
The scale_factor of this Displacement. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.displacement_field module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.displacement_field.DisplacementField(type='DISPLACEMENT', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this DisplacementField. # noqa: E501
Choose a field component for which the data schould be extracted. # noqa: E501
- Returns
The component_selection of this DisplacementField. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DisplacementField. # noqa: E501
<p>Select the field which should have a limited de-/increase within one increment.</p> Schema name: DisplacementField # noqa: E501
- Returns
The type of this DisplacementField. # noqa: E501
- Return type
str
simscale_sdk.models.displacement_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.displacement_field_selection.DisplacementFieldSelection(type='DISPLACEMENT', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this DisplacementFieldSelection. # noqa: E501
- Returns
The component_selection of this DisplacementFieldSelection. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DisplacementFieldSelection. # noqa: E501
Schema name: DisplacementFieldSelection # noqa: E501
- Returns
The type of this DisplacementFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.displacement_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.displacement_result_control_item.DisplacementResultControlItem(type='DISPLACEMENT', name=None, displacement_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'displacement_type': 'displacementType', 'name': 'name', 'type': 'type'}¶
- property displacement_type¶
Gets the displacement_type of this DisplacementResultControlItem. # noqa: E501
- Returns
The displacement_type of this DisplacementResultControlItem. # noqa: E501
- Return type
- property name¶
Gets the name of this DisplacementResultControlItem. # noqa: E501
- Returns
The name of this DisplacementResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'displacement_type': 'GlobalDisplacementType', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DisplacementResultControlItem. # noqa: E501
Schema name: DisplacementResultControlItem # noqa: E501
- Returns
The type of this DisplacementResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.distance_region_refinement_with_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.distance_region_refinement_with_length.DistanceRegionRefinementWithLength(type='DISTANCE', distance_refinement_lengths=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distance_refinement_lengths': 'distanceRefinementLengths', 'type': 'type'}¶
- property distance_refinement_lengths¶
Gets the distance_refinement_lengths of this DistanceRegionRefinementWithLength. # noqa: E501
Define the desired cell edge length based on the distance to the surface of the assigned volumes. The distances need to be specified in <u>descending order</u> from top to bottom in the table. # noqa: E501
- Returns
The distance_refinement_lengths of this DistanceRegionRefinementWithLength. # noqa: E501
- Return type
list[RefinementLength]
- openapi_types = {'distance_refinement_lengths': 'list[RefinementLength]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DistanceRegionRefinementWithLength. # noqa: E501
Schema name: DistanceRegionRefinementWithLength # noqa: E501
- Returns
The type of this DistanceRegionRefinementWithLength. # noqa: E501
- Return type
str
simscale_sdk.models.distance_region_refinement_with_levels module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.distance_region_refinement_with_levels.DistanceRegionRefinementWithLevels(type='DISTANCE', distance_refinement_levels=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distance_refinement_levels': 'distanceRefinementLevels', 'type': 'type'}¶
- property distance_refinement_levels¶
Gets the distance_refinement_levels of this DistanceRegionRefinementWithLevels. # noqa: E501
- Returns
The distance_refinement_levels of this DistanceRegionRefinementWithLevels. # noqa: E501
- Return type
list[RefinementLevel]
- openapi_types = {'distance_refinement_levels': 'list[RefinementLevel]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DistanceRegionRefinementWithLevels. # noqa: E501
Schema name: DistanceRegionRefinementWithLevels # noqa: E501
- Returns
The type of this DistanceRegionRefinementWithLevels. # noqa: E501
- Return type
str
simscale_sdk.models.distributed_isotropic_stiffness_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.distributed_isotropic_stiffness_definition.DistributedIsotropicStiffnessDefinition(type='DISTRIBUTED_ISOTROPIC', distributed=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distributed': 'distributed', 'type': 'type'}¶
- property distributed¶
Gets the distributed of this DistributedIsotropicStiffnessDefinition. # noqa: E501
- Returns
The distributed of this DistributedIsotropicStiffnessDefinition. # noqa: E501
- Return type
- openapi_types = {'distributed': 'DimensionalVolumeForce', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DistributedIsotropicStiffnessDefinition. # noqa: E501
Schema name: DistributedIsotropicStiffnessDefinition # noqa: E501
- Returns
The type of this DistributedIsotropicStiffnessDefinition. # noqa: E501
- Return type
str
simscale_sdk.models.distributed_orthotropic_stiffness_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.distributed_orthotropic_stiffness_definition.DistributedOrthotropicStiffnessDefinition(type='DISTRIBUTED_ORTHOTROPIC', distributed=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distributed': 'distributed', 'type': 'type'}¶
- property distributed¶
Gets the distributed of this DistributedOrthotropicStiffnessDefinition. # noqa: E501
- Returns
The distributed of this DistributedOrthotropicStiffnessDefinition. # noqa: E501
- Return type
- openapi_types = {'distributed': 'DimensionalVectorVolumeForce', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DistributedOrthotropicStiffnessDefinition. # noqa: E501
Schema name: DistributedOrthotropicStiffnessDefinition # noqa: E501
- Returns
The type of this DistributedOrthotropicStiffnessDefinition. # noqa: E501
- Return type
str
simscale_sdk.models.divergence_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.divergence_schemes.DivergenceSchemes(for_default=None, div_phi_velocity=None, div_phi_kinetic_energy=None, div_phi_enthalpy=None, div_phi_internal_energy=None, div_phiv_pressure=None, div_phi_turbulent_kinetic_energy=None, div_nu_eff_dev_t_grad_velocity=None, div_mu_eff_dev2_t_grad_velocity=None, div_phi_omega_dissipation_rate=None, div_phi_epsilon_dissipation_rate=None, div_r=None, div_phi_r=None, div_phi_nu_tilda=None, div_phi_temperature=None, div_phi_passive_scalar=None, div_tau_mc=None, div_phid_pressure=None, div_velocity=None, div_phi_ekp=None, div_phirb_alpha=None, div_mu_eff_dev_t_grad_velocity=None, div_phi_alpha=None, div_rho_phi_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'div_mu_eff_dev2_t_grad_velocity': 'div_MuEff_dev2_T_grad_velocity', 'div_mu_eff_dev_t_grad_velocity': 'div_muEff_dev_T_grad_velocity', 'div_nu_eff_dev_t_grad_velocity': 'div_NuEff_dev_T_grad_velocity', 'div_phi_alpha': 'div_phi_alpha', 'div_phi_ekp': 'div_phi_Ekp', 'div_phi_enthalpy': 'div_Phi_enthalpy', 'div_phi_epsilon_dissipation_rate': 'div_Phi_epsilonDissipationRate', 'div_phi_internal_energy': 'div_Phi_internalEnergy', 'div_phi_kinetic_energy': 'div_Phi_kineticEnergy', 'div_phi_nu_tilda': 'div_Phi_nuTilda', 'div_phi_omega_dissipation_rate': 'div_Phi_omegaDissipationRate', 'div_phi_passive_scalar': 'div_Phi_passiveScalar', 'div_phi_r': 'div_Phi_R', 'div_phi_temperature': 'div_Phi_temperature', 'div_phi_turbulent_kinetic_energy': 'div_Phi_turbulentKineticEnergy', 'div_phi_velocity': 'div_Phi_velocity', 'div_phid_pressure': 'div_phid_pressure', 'div_phirb_alpha': 'div_phirb_alpha', 'div_phiv_pressure': 'div_Phiv_pressure', 'div_r': 'div_R', 'div_rho_phi_velocity': 'div_rhoPhi_velocity', 'div_tau_mc': 'div_tauMC', 'div_velocity': 'div_velocity', 'for_default': 'forDefault'}¶
- property div_mu_eff_dev2_t_grad_velocity¶
Gets the div_mu_eff_dev2_t_grad_velocity of this DivergenceSchemes. # noqa: E501
- Returns
The div_mu_eff_dev2_t_grad_velocity of this DivergenceSchemes. # noqa: E501
- Return type
- property div_mu_eff_dev_t_grad_velocity¶
Gets the div_mu_eff_dev_t_grad_velocity of this DivergenceSchemes. # noqa: E501
- Returns
The div_mu_eff_dev_t_grad_velocity of this DivergenceSchemes. # noqa: E501
- Return type
- property div_nu_eff_dev_t_grad_velocity¶
Gets the div_nu_eff_dev_t_grad_velocity of this DivergenceSchemes. # noqa: E501
- Returns
The div_nu_eff_dev_t_grad_velocity of this DivergenceSchemes. # noqa: E501
- Return type
- property div_phi_alpha¶
Gets the div_phi_alpha of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_alpha of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiAlpha
- property div_phi_ekp¶
Gets the div_phi_ekp of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_ekp of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiEkp
- property div_phi_enthalpy¶
Gets the div_phi_enthalpy of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_enthalpy of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiEnthalpy
- property div_phi_epsilon_dissipation_rate¶
Gets the div_phi_epsilon_dissipation_rate of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_epsilon_dissipation_rate of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiEpsilonDissipationRate
- property div_phi_internal_energy¶
Gets the div_phi_internal_energy of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_internal_energy of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiInternalEnergy
- property div_phi_kinetic_energy¶
Gets the div_phi_kinetic_energy of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_kinetic_energy of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiKineticEnergy
- property div_phi_nu_tilda¶
Gets the div_phi_nu_tilda of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_nu_tilda of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiNuTilda
- property div_phi_omega_dissipation_rate¶
Gets the div_phi_omega_dissipation_rate of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_omega_dissipation_rate of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiOmegaDissipationRate
- property div_phi_passive_scalar¶
Gets the div_phi_passive_scalar of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_passive_scalar of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiPassiveScalar
- property div_phi_r¶
Gets the div_phi_r of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_r of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiR
- property div_phi_temperature¶
Gets the div_phi_temperature of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_temperature of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiTemperature
- property div_phi_turbulent_kinetic_energy¶
Gets the div_phi_turbulent_kinetic_energy of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_turbulent_kinetic_energy of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiTurbulentKineticEnergy
- property div_phi_velocity¶
Gets the div_phi_velocity of this DivergenceSchemes. # noqa: E501
- Returns
The div_phi_velocity of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhiVelocity
- property div_phid_pressure¶
Gets the div_phid_pressure of this DivergenceSchemes. # noqa: E501
- Returns
The div_phid_pressure of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhidPressure
- property div_phirb_alpha¶
Gets the div_phirb_alpha of this DivergenceSchemes. # noqa: E501
- Returns
The div_phirb_alpha of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhirbAlpha
- property div_phiv_pressure¶
Gets the div_phiv_pressure of this DivergenceSchemes. # noqa: E501
- Returns
The div_phiv_pressure of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivPhivPressure
- property div_r¶
Gets the div_r of this DivergenceSchemes. # noqa: E501
- Returns
The div_r of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivR
- property div_rho_phi_velocity¶
Gets the div_rho_phi_velocity of this DivergenceSchemes. # noqa: E501
- Returns
The div_rho_phi_velocity of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivRhoPhiVelocity
- property div_tau_mc¶
Gets the div_tau_mc of this DivergenceSchemes. # noqa: E501
- Returns
The div_tau_mc of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivTauMC
- property div_velocity¶
Gets the div_velocity of this DivergenceSchemes. # noqa: E501
- Returns
The div_velocity of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesDivVelocity
- property for_default¶
Gets the for_default of this DivergenceSchemes. # noqa: E501
- Returns
The for_default of this DivergenceSchemes. # noqa: E501
- Return type
OneOfDivergenceSchemesForDefault
- openapi_types = {'div_mu_eff_dev2_t_grad_velocity': 'GaussLinearDivergenceScheme', 'div_mu_eff_dev_t_grad_velocity': 'GaussLinearDivergenceScheme', 'div_nu_eff_dev_t_grad_velocity': 'GaussLinearDivergenceScheme', 'div_phi_alpha': 'OneOfDivergenceSchemesDivPhiAlpha', 'div_phi_ekp': 'OneOfDivergenceSchemesDivPhiEkp', 'div_phi_enthalpy': 'OneOfDivergenceSchemesDivPhiEnthalpy', 'div_phi_epsilon_dissipation_rate': 'OneOfDivergenceSchemesDivPhiEpsilonDissipationRate', 'div_phi_internal_energy': 'OneOfDivergenceSchemesDivPhiInternalEnergy', 'div_phi_kinetic_energy': 'OneOfDivergenceSchemesDivPhiKineticEnergy', 'div_phi_nu_tilda': 'OneOfDivergenceSchemesDivPhiNuTilda', 'div_phi_omega_dissipation_rate': 'OneOfDivergenceSchemesDivPhiOmegaDissipationRate', 'div_phi_passive_scalar': 'OneOfDivergenceSchemesDivPhiPassiveScalar', 'div_phi_r': 'OneOfDivergenceSchemesDivPhiR', 'div_phi_temperature': 'OneOfDivergenceSchemesDivPhiTemperature', 'div_phi_turbulent_kinetic_energy': 'OneOfDivergenceSchemesDivPhiTurbulentKineticEnergy', 'div_phi_velocity': 'OneOfDivergenceSchemesDivPhiVelocity', 'div_phid_pressure': 'OneOfDivergenceSchemesDivPhidPressure', 'div_phirb_alpha': 'OneOfDivergenceSchemesDivPhirbAlpha', 'div_phiv_pressure': 'OneOfDivergenceSchemesDivPhivPressure', 'div_r': 'OneOfDivergenceSchemesDivR', 'div_rho_phi_velocity': 'OneOfDivergenceSchemesDivRhoPhiVelocity', 'div_tau_mc': 'OneOfDivergenceSchemesDivTauMC', 'div_velocity': 'OneOfDivergenceSchemesDivVelocity', 'for_default': 'OneOfDivergenceSchemesForDefault'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.download_info module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.download_info.DownloadInfo(format=None, uncompressed_size_in_bytes=None, url=None, compression=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'compression': 'compression', 'format': 'format', 'uncompressed_size_in_bytes': 'uncompressedSizeInBytes', 'url': 'url'}¶
- property compression¶
Gets the compression of this DownloadInfo. # noqa: E501
The compression used for the report result download archive. # noqa: E501
- Returns
The compression of this DownloadInfo. # noqa: E501
- Return type
str
- property format¶
Gets the format of this DownloadInfo. # noqa: E501
The result format. # noqa: E501
- Returns
The format of this DownloadInfo. # noqa: E501
- Return type
str
- openapi_types = {'compression': 'str', 'format': 'str', 'uncompressed_size_in_bytes': 'int', 'url': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property uncompressed_size_in_bytes¶
Gets the uncompressed_size_in_bytes of this DownloadInfo. # noqa: E501
The uncompressed size of the report result content. # noqa: E501
- Returns
The uncompressed_size_in_bytes of this DownloadInfo. # noqa: E501
- Return type
int
- property url¶
Gets the url of this DownloadInfo. # noqa: E501
URL for downloading the report result content. # noqa: E501
- Returns
The url of this DownloadInfo. # noqa: E501
- Return type
str
simscale_sdk.models.duration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.duration.Duration(value=None, interval_min=None, interval_max=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'interval_max': 'intervalMax', 'interval_min': 'intervalMin', 'value': 'value'}¶
- property interval_max¶
Gets the interval_max of this Duration. # noqa: E501
- Returns
The interval_max of this Duration. # noqa: E501
- Return type
str
- property interval_min¶
Gets the interval_min of this Duration. # noqa: E501
- Returns
The interval_min of this Duration. # noqa: E501
- Return type
str
- openapi_types = {'interval_max': 'str', 'interval_min': 'str', 'value': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property value¶
Gets the value of this Duration. # noqa: E501
- Returns
The value of this Duration. # noqa: E501
- Return type
str
simscale_sdk.models.dynamic_analysis module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dynamic_analysis.DynamicAnalysis(type='DYNAMIC_ANALYSIS', connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'element_technology': 'elementTechnology', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'mesh_order': 'meshOrder', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this DynamicAnalysis. # noqa: E501
- Returns
The boundary_conditions of this DynamicAnalysis. # noqa: E501
- Return type
list[OneOfDynamicAnalysisBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this DynamicAnalysis. # noqa: E501
- Returns
The connection_groups of this DynamicAnalysis. # noqa: E501
- Return type
list[OneOfDynamicAnalysisConnectionGroups]
- property element_technology¶
Gets the element_technology of this DynamicAnalysis. # noqa: E501
- Returns
The element_technology of this DynamicAnalysis. # noqa: E501
- Return type
- property initial_conditions¶
Gets the initial_conditions of this DynamicAnalysis. # noqa: E501
- Returns
The initial_conditions of this DynamicAnalysis. # noqa: E501
- Return type
- property materials¶
Gets the materials of this DynamicAnalysis. # noqa: E501
- Returns
The materials of this DynamicAnalysis. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this DynamicAnalysis. # noqa: E501
- Returns
The mesh_order of this DynamicAnalysis. # noqa: E501
- Return type
str
- property model¶
Gets the model of this DynamicAnalysis. # noqa: E501
- Returns
The model of this DynamicAnalysis. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this DynamicAnalysis. # noqa: E501
- Returns
The numerics of this DynamicAnalysis. # noqa: E501
- Return type
- openapi_types = {'boundary_conditions': 'list[OneOfDynamicAnalysisBoundaryConditions]', 'connection_groups': 'list[OneOfDynamicAnalysisConnectionGroups]', 'element_technology': 'SolidElementTechnology', 'initial_conditions': 'SolidInitialConditions', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'model': 'SolidModel', 'numerics': 'SolidNumerics', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this DynamicAnalysis. # noqa: E501
- Returns
The result_control of this DynamicAnalysis. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this DynamicAnalysis. # noqa: E501
- Returns
The simulation_control of this DynamicAnalysis. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DynamicAnalysis. # noqa: E501
Schema name: DynamicAnalysis # noqa: E501
- Returns
The type of this DynamicAnalysis. # noqa: E501
- Return type
str
simscale_sdk.models.dynamic_contact_angle_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.dynamic_contact_angle_pfbc.DynamicContactAnglePFBC(type='DYNAMIC_CONTACT_ANGLE', equilibrium_contact_angle=None, advancing_contact_angle=None, receding_contact_angle=None, velocity_scale_of_contact_angle=None, limit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advancing_contact_angle¶
Gets the advancing_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Returns
The advancing_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Return type
- attribute_map = {'advancing_contact_angle': 'advancingContactAngle', 'equilibrium_contact_angle': 'equilibriumContactAngle', 'limit': 'limit', 'receding_contact_angle': 'recedingContactAngle', 'type': 'type', 'velocity_scale_of_contact_angle': 'velocityScaleOfContactAngle'}¶
- property equilibrium_contact_angle¶
Gets the equilibrium_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Returns
The equilibrium_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Return type
- property limit¶
Gets the limit of this DynamicContactAnglePFBC. # noqa: E501
- Returns
The limit of this DynamicContactAnglePFBC. # noqa: E501
- Return type
str
- openapi_types = {'advancing_contact_angle': 'DimensionalAngle', 'equilibrium_contact_angle': 'DimensionalAngle', 'limit': 'str', 'receding_contact_angle': 'DimensionalAngle', 'type': 'str', 'velocity_scale_of_contact_angle': 'float'}¶
- property receding_contact_angle¶
Gets the receding_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Returns
The receding_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this DynamicContactAnglePFBC. # noqa: E501
Schema name: DynamicContactAnglePFBC # noqa: E501
- Returns
The type of this DynamicContactAnglePFBC. # noqa: E501
- Return type
str
- property velocity_scale_of_contact_angle¶
Gets the velocity_scale_of_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Returns
The velocity_scale_of_contact_angle of this DynamicContactAnglePFBC. # noqa: E501
- Return type
float
simscale_sdk.models.e_const_thermo module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.e_const_thermo.EConstThermo(type='ECONST', specific_heat=None, equation_of_state=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'equation_of_state': 'equationOfState', 'specific_heat': 'specificHeat', 'type': 'type'}¶
- property equation_of_state¶
Gets the equation_of_state of this EConstThermo. # noqa: E501
- Returns
The equation_of_state of this EConstThermo. # noqa: E501
- Return type
- openapi_types = {'equation_of_state': 'PerfectGasEquationOfState', 'specific_heat': 'DimensionalSpecificHeat', 'type': 'str'}¶
- property specific_heat¶
Gets the specific_heat of this EConstThermo. # noqa: E501
- Returns
The specific_heat of this EConstThermo. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this EConstThermo. # noqa: E501
<br><p>The <b>Thermo models</b> are used to calculate the specific heat at constant pressure (<i>Cp</i>) for the fluid. The available models are:</p><p><b>hConst:</b> This model assumes a constant value for specific heat at fixed pressure (<i>Cp</i>). </p><p><b>eConst:</b> This model assumes a constant value for the specific heat at fixed volume (<i>Cv</i>). </p> Schema name: EConstThermo # noqa: E501
- Returns
The type of this EConstThermo. # noqa: E501
- Return type
str
simscale_sdk.models.eigen_mode_verification module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.eigen_mode_verification.EigenModeVerification(stop_error=None, threshold=None, precision_shift=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'precision_shift': 'precisionShift', 'stop_error': 'stopError', 'threshold': 'threshold'}¶
- openapi_types = {'precision_shift': 'float', 'stop_error': 'bool', 'threshold': 'float'}¶
- property precision_shift¶
Gets the precision_shift of this EigenModeVerification. # noqa: E501
- Returns
The precision_shift of this EigenModeVerification. # noqa: E501
- Return type
float
- property stop_error¶
Gets the stop_error of this EigenModeVerification. # noqa: E501
- Returns
The stop_error of this EigenModeVerification. # noqa: E501
- Return type
bool
- property threshold¶
Gets the threshold of this EigenModeVerification. # noqa: E501
- Returns
The threshold of this EigenModeVerification. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.elastic_jacobian_matrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.elastic_jacobian_matrix.ElasticJacobianMatrix(type='ELASTIC', max_newton_iteration=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_newton_iteration': 'maxNewtonIteration', 'type': 'type'}¶
- property max_newton_iteration¶
Gets the max_newton_iteration of this ElasticJacobianMatrix. # noqa: E501
<p>Maximum number of allowed Newton iterations per time increment. If this value is reached the simulation is considered non-converging. If an automatic time stepping is activated the time increment is reduced in order to reach convergence.</p> # noqa: E501
- Returns
The max_newton_iteration of this ElasticJacobianMatrix. # noqa: E501
- Return type
int
- openapi_types = {'max_newton_iteration': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ElasticJacobianMatrix. # noqa: E501
<p>Select which stiffnes matrix should be used for computing the Jacobian of the Newton method. Choosing the tangent stiffnes matrix via <b>tangent matrix</b> allows a full Newton approach whereas the selection of the <b>elastic matrix</b> results in a quasi-Newton approach.</p> Schema name: ElasticJacobianMatrix # noqa: E501
- Returns
The type of this ElasticJacobianMatrix. # noqa: E501
- Return type
str
simscale_sdk.models.elastic_support_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.elastic_support_bc.ElasticSupportBC(type='ELASTIC_SUPPORT', name=None, spring_stiffness=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'spring_stiffness': 'springStiffness', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this ElasticSupportBC. # noqa: E501
- Returns
The name of this ElasticSupportBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'spring_stiffness': 'OneOfElasticSupportBCSpringStiffness', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property spring_stiffness¶
Gets the spring_stiffness of this ElasticSupportBC. # noqa: E501
- Returns
The spring_stiffness of this ElasticSupportBC. # noqa: E501
- Return type
OneOfElasticSupportBCSpringStiffness
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this ElasticSupportBC. # noqa: E501
- Returns
The topological_reference of this ElasticSupportBC. # noqa: E501
- Return type
- property type¶
Gets the type of this ElasticSupportBC. # noqa: E501
<p>The <b>elastic support</b> constraint can be used to model an <b>elastic foundation</b> between the assigned surfaces and the rigid ground. Additionally it can be used to <b>prevent rigid body motions</b> in a nonlinear analysis. The constraint acts on tension and compression forces and all stiffness values are expressed in the global coordinate system.<br><a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/elastic-support/’ target’blank’>Learn more</a>.</p> Schema name: ElasticSupportBC # noqa: E501
- Returns
The type of this ElasticSupportBC. # noqa: E501
- Return type
str
simscale_sdk.models.element_technology module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.element_technology.ElementTechnology(mechanical_element_type=None, thermal_element_type=None, thermal_mass_order_reduction=None, definitions=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'definitions': 'definitions', 'mechanical_element_type': 'mechanicalElementType', 'thermal_element_type': 'thermalElementType', 'thermal_mass_order_reduction': 'thermalMassOrderReduction'}¶
- property definitions¶
Gets the definitions of this ElementTechnology. # noqa: E501
- Returns
The definitions of this ElementTechnology. # noqa: E501
- Return type
- property mechanical_element_type¶
Gets the mechanical_element_type of this ElementTechnology. # noqa: E501
- Returns
The mechanical_element_type of this ElementTechnology. # noqa: E501
- Return type
str
- openapi_types = {'definitions': 'list[ElementTechnologyDefinition]', 'mechanical_element_type': 'str', 'thermal_element_type': 'str', 'thermal_mass_order_reduction': 'bool'}¶
- property thermal_element_type¶
Gets the thermal_element_type of this ElementTechnology. # noqa: E501
- Returns
The thermal_element_type of this ElementTechnology. # noqa: E501
- Return type
str
- property thermal_mass_order_reduction¶
Gets the thermal_mass_order_reduction of this ElementTechnology. # noqa: E501
- Returns
The thermal_mass_order_reduction of this ElementTechnology. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.element_technology_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.element_technology_definition.ElementTechnologyDefinition(name=None, mechanical_element_type=None, thermal_element_type=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mechanical_element_type': 'mechanicalElementType', 'name': 'name', 'thermal_element_type': 'thermalElementType', 'topological_reference': 'topologicalReference'}¶
- property mechanical_element_type¶
Gets the mechanical_element_type of this ElementTechnologyDefinition. # noqa: E501
- Returns
The mechanical_element_type of this ElementTechnologyDefinition. # noqa: E501
- Return type
str
- property name¶
Gets the name of this ElementTechnologyDefinition. # noqa: E501
- Returns
The name of this ElementTechnologyDefinition. # noqa: E501
- Return type
str
- openapi_types = {'mechanical_element_type': 'str', 'name': 'str', 'thermal_element_type': 'str', 'topological_reference': 'TopologicalReference'}¶
- property thermal_element_type¶
Gets the thermal_element_type of this ElementTechnologyDefinition. # noqa: E501
- Returns
The thermal_element_type of this ElementTechnologyDefinition. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this ElementTechnologyDefinition. # noqa: E501
- Returns
The topological_reference of this ElementTechnologyDefinition. # noqa: E501
- Return type
simscale_sdk.models.embedded_boundary module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.embedded_boundary.EmbeddedBoundary(type='EMBEDDED_BOUNDARY', is_internal_flow=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, mesh_settings=None, is_compressible=None, enable_radiation=None, turbulence_model=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this EmbeddedBoundary. # noqa: E501
- Returns
The advanced_concepts of this EmbeddedBoundary. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'enable_radiation': 'enableRadiation', 'initial_conditions': 'initialConditions', 'is_compressible': 'isCompressible', 'is_internal_flow': 'isInternalFlow', 'materials': 'materials', 'mesh_settings': 'meshSettings', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this EmbeddedBoundary. # noqa: E501
- Returns
The boundary_conditions of this EmbeddedBoundary. # noqa: E501
- Return type
list[OneOfEmbeddedBoundaryBoundaryConditions]
- property enable_radiation¶
Gets the enable_radiation of this EmbeddedBoundary. # noqa: E501
Heat transfer through radiation takes place in the form of electromagnetic waves and it can be calculated in the simulation. This phenomenon becomes more important when the temperatures involved in the simulation are large. <a href=’https://www.simscale.com/docs/analysis-types/convective-heat-transfer-analysis/radiation/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The enable_radiation of this EmbeddedBoundary. # noqa: E501
- Return type
bool
- property initial_conditions¶
Gets the initial_conditions of this EmbeddedBoundary. # noqa: E501
- Returns
The initial_conditions of this EmbeddedBoundary. # noqa: E501
- Return type
- property is_compressible¶
Gets the is_compressible of this EmbeddedBoundary. # noqa: E501
<ul><li>Toggle off <em>Compressible</em> for small temperature variations within the domain, for example, in natural convection simulations (Boussinesq approximation). Use Gauge pressure (0 Pa). </li><li>Toggle on <em>Compressible</em> to calculate resulting density variations within the domain based on pressure and temperature. Use Absolute pressure (for example, 101325 Pa at sea level)</li></ul> # noqa: E501
- Returns
The is_compressible of this EmbeddedBoundary. # noqa: E501
- Return type
bool
- property is_internal_flow¶
Gets the is_internal_flow of this EmbeddedBoundary. # noqa: E501
If active it indicates that the fluid region is contained within the uploaded geometry. # noqa: E501
- Returns
The is_internal_flow of this EmbeddedBoundary. # noqa: E501
- Return type
bool
- property materials¶
Gets the materials of this EmbeddedBoundary. # noqa: E501
- Returns
The materials of this EmbeddedBoundary. # noqa: E501
- Return type
- property mesh_settings¶
Gets the mesh_settings of this EmbeddedBoundary. # noqa: E501
- Returns
The mesh_settings of this EmbeddedBoundary. # noqa: E501
- Return type
- property model¶
Gets the model of this EmbeddedBoundary. # noqa: E501
- Returns
The model of this EmbeddedBoundary. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this EmbeddedBoundary. # noqa: E501
- Returns
The numerics of this EmbeddedBoundary. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfEmbeddedBoundaryBoundaryConditions]', 'enable_radiation': 'bool', 'initial_conditions': 'FluidInitialConditions', 'is_compressible': 'bool', 'is_internal_flow': 'bool', 'materials': 'CoupledConjugateHeatTransferMaterials', 'mesh_settings': 'BasicEmbeddedBoundaryMeshing', 'model': 'FluidModel', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this EmbeddedBoundary. # noqa: E501
- Returns
The result_control of this EmbeddedBoundary. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this EmbeddedBoundary. # noqa: E501
- Returns
The simulation_control of this EmbeddedBoundary. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this EmbeddedBoundary. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this EmbeddedBoundary. # noqa: E501
- Return type
str
- property type¶
Gets the type of this EmbeddedBoundary. # noqa: E501
Schema name: EmbeddedBoundary # noqa: E501
- Returns
The type of this EmbeddedBoundary. # noqa: E501
- Return type
str
simscale_sdk.models.embedded_distance_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.embedded_distance_refinement.EmbeddedDistanceRefinement(type='DISTANCE_REFINEMENT', refinement_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'refinement_control': 'refinementControl', 'type': 'type'}¶
- openapi_types = {'refinement_control': 'DimensionalLength', 'type': 'str'}¶
- property refinement_control¶
Gets the refinement_control of this EmbeddedDistanceRefinement. # noqa: E501
- Returns
The refinement_control of this EmbeddedDistanceRefinement. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this EmbeddedDistanceRefinement. # noqa: E501
Schema name: EmbeddedDistanceRefinement # noqa: E501
- Returns
The type of this EmbeddedDistanceRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.embedded_number_of_cells_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.embedded_number_of_cells_refinement.EmbeddedNumberOfCellsRefinement(type='LAYER_REFINEMENT', refinement_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'refinement_control': 'refinementControl', 'type': 'type'}¶
- openapi_types = {'refinement_control': 'int', 'type': 'str'}¶
- property refinement_control¶
Gets the refinement_control of this EmbeddedNumberOfCellsRefinement. # noqa: E501
Number of cell layers up to which the mesh refinement propagates. # noqa: E501
- Returns
The refinement_control of this EmbeddedNumberOfCellsRefinement. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this EmbeddedNumberOfCellsRefinement. # noqa: E501
Schema name: EmbeddedNumberOfCellsRefinement # noqa: E501
- Returns
The type of this EmbeddedNumberOfCellsRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.empty2_dbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.empty2_dbc.Empty2DBC(type='EMPTY_2D', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this Empty2DBC. # noqa: E501
- Returns
The name of this Empty2DBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this Empty2DBC. # noqa: E501
- Returns
The topological_reference of this Empty2DBC. # noqa: E501
- Return type
- property type¶
Gets the type of this Empty2DBC. # noqa: E501
This boundary condition is intended only for uploaded 2D OpenFOAM meshes. A 2D mesh is ensured by having a single cell thickness in one of the 3 spatial directions. <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/empty-2d/’ target=’_blank’>Learn more.</a> Schema name: Empty2DBC # noqa: E501
- Returns
The type of this Empty2DBC. # noqa: E501
- Return type
str
simscale_sdk.models.entity_attribute module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.entity_attribute.EntityAttribute(attribute=None, value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property attribute¶
Gets the attribute of this EntityAttribute. # noqa: E501
- Returns
The attribute of this EntityAttribute. # noqa: E501
- Return type
str
- attribute_map = {'attribute': 'attribute', 'value': 'value'}¶
- openapi_types = {'attribute': 'str', 'value': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property value¶
Gets the value of this EntityAttribute. # noqa: E501
- Returns
The value of this EntityAttribute. # noqa: E501
- Return type
str
simscale_sdk.models.entity_description module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.entity_description.EntityDescription(name=None, _class=None, originate_from=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_class': 'class', 'name': 'name', 'originate_from': 'originateFrom'}¶
- property name¶
Gets the name of this EntityDescription. # noqa: E501
The internal name of the entity. # noqa: E501
- Returns
The name of this EntityDescription. # noqa: E501
- Return type
str
- openapi_types = {'_class': 'str', 'name': 'str', 'originate_from': 'list[OriginalEntityReference]'}¶
- property originate_from¶
Gets the originate_from of this EntityDescription. # noqa: E501
- Returns
The originate_from of this EntityDescription. # noqa: E501
- Return type
list[OriginalEntityReference]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.error_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.error_response.ErrorResponse(severity=None, code=None, message=None, details=None, trace=None, entries=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'code': 'code', 'details': 'details', 'entries': 'entries', 'message': 'message', 'severity': 'severity', 'trace': 'trace'}¶
- property code¶
Gets the code of this ErrorResponse. # noqa: E501
Code for e.g. programmatic handling of error conditions. # noqa: E501
- Returns
The code of this ErrorResponse. # noqa: E501
- Return type
str
- property details¶
Gets the details of this ErrorResponse. # noqa: E501
Additional data to interpret and handle the entry. # noqa: E501
- Returns
The details of this ErrorResponse. # noqa: E501
- Return type
dict(str, object)
- property entries¶
Gets the entries of this ErrorResponse. # noqa: E501
- Returns
The entries of this ErrorResponse. # noqa: E501
- Return type
list[LogEntry]
- property message¶
Gets the message of this ErrorResponse. # noqa: E501
Human-readable description of the entry. # noqa: E501
- Returns
The message of this ErrorResponse. # noqa: E501
- Return type
str
- openapi_types = {'code': 'str', 'details': 'dict(str, object)', 'entries': 'list[LogEntry]', 'message': 'str', 'severity': 'LogSeverity', 'trace': 'str'}¶
- property severity¶
Gets the severity of this ErrorResponse. # noqa: E501
- Returns
The severity of this ErrorResponse. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property trace¶
Gets the trace of this ErrorResponse. # noqa: E501
- Returns
The trace of this ErrorResponse. # noqa: E501
- Return type
str
simscale_sdk.models.error_retiming_event module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.error_retiming_event.ErrorRetimingEvent(type='ERROR', timestep_calculation_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'timestep_calculation_type': 'timestepCalculationType', 'type': 'type'}¶
- openapi_types = {'timestep_calculation_type': 'OneOfErrorRetimingEventTimestepCalculationType', 'type': 'str'}¶
- property timestep_calculation_type¶
Gets the timestep_calculation_type of this ErrorRetimingEvent. # noqa: E501
- Returns
The timestep_calculation_type of this ErrorRetimingEvent. # noqa: E501
- Return type
OneOfErrorRetimingEventTimestepCalculationType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ErrorRetimingEvent. # noqa: E501
<p>Select the event for the time step adaptation. Currently there are four different events possible that trigger a time step adaptation:</p><ul><li><p><b>Error</b>: This is the case of a general error like for example non-convergence or singular matrix errors.</p></ul><ul><li><p><b>Collision</b>: This event is triggered if in a computation with physical contact a contact state change from open to closed is noticed. This time step adaptation is especially useful in dynamics to reduce the effect of artificial oscillations due to inexact collision detection.</p></ul><ul><li><p><b>Field Change</b>: The user can define the maximum delta that a field is allowed to change within one time step, if the defined threshold is exceeded the time step is adapted. This time stepping criteria is especially useful to capture material nonlinearitier more exact.</p></ul><ul><li><p><b>Non-monotonous residual</b>: This event is triggered if the residual has not been reduced within three iterations . This criteria is mostly used to reduce runtime by detecting diverging time steps before reaching the maximum number of allowed newton iterations.</p></ul> Schema name: ErrorRetimingEvent # noqa: E501
- Returns
The type of this ErrorRetimingEvent. # noqa: E501
- Return type
str
simscale_sdk.models.estimation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.estimation.Estimation(duration=None, compute_resource=None, cell_count=None, total_run_count=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cell_count': 'cellCount', 'compute_resource': 'computeResource', 'duration': 'duration', 'total_run_count': 'totalRunCount'}¶
- property cell_count¶
Gets the cell_count of this Estimation. # noqa: E501
- Returns
The cell_count of this Estimation. # noqa: E501
- Return type
- property compute_resource¶
Gets the compute_resource of this Estimation. # noqa: E501
- Returns
The compute_resource of this Estimation. # noqa: E501
- Return type
- property duration¶
Gets the duration of this Estimation. # noqa: E501
- Returns
The duration of this Estimation. # noqa: E501
- Return type
- openapi_types = {'cell_count': 'CellCount', 'compute_resource': 'ComputeResource', 'duration': 'Duration', 'total_run_count': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total_run_count¶
Gets the total_run_count of this Estimation. # noqa: E501
The total number of jobs that will be triggered for this simulation run or mesh operation. # noqa: E501
- Returns
The total_run_count of this Estimation. # noqa: E501
- Return type
int
simscale_sdk.models.euler_time_differentiation_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.euler_time_differentiation_scheme.EulerTimeDifferentiationScheme(type='EULER', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this EulerTimeDifferentiationScheme. # noqa: E501
Schema name: EulerTimeDifferentiationScheme # noqa: E501
- Returns
The type of this EulerTimeDifferentiationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.event_log_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.event_log_response.EventLogResponse(entries=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'entries': 'entries'}¶
- property entries¶
Gets the entries of this EventLogResponse. # noqa: E501
- Returns
The entries of this EventLogResponse. # noqa: E501
- Return type
list[LogEntry]
- openapi_types = {'entries': 'list[LogEntry]'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.explicit_time_integration_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.explicit_time_integration_type.ExplicitTimeIntegrationType(type='EXPLICIT', scheme=None, scheme_formulation=None, stop_on_cfl_criterion=None, mass_matrix_shift=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mass_matrix_shift': 'massMatrixShift', 'scheme': 'scheme', 'scheme_formulation': 'schemeFormulation', 'stop_on_cfl_criterion': 'stopOnCFLCriterion', 'type': 'type'}¶
- property mass_matrix_shift¶
Gets the mass_matrix_shift of this ExplicitTimeIntegrationType. # noqa: E501
<p>This parameter c<sub>K</sub> allows the shifting of the mass matrix with the stiffness matrix multiplied by c<sub>K</sub>: <b>M</b><sup>’</sup>=<b>M</b> + c<sub>K</sub>*<b>K</b>. This makes it possible to strongly improve convergence in dynamics with implicit time scheme by imposing a cut-off frequency inversely proportional to the value of c<sub>K</sub> (at the cost of a light distortion of all the eigen frequencies of the system).</p> # noqa: E501
- Returns
The mass_matrix_shift of this ExplicitTimeIntegrationType. # noqa: E501
- Return type
float
- openapi_types = {'mass_matrix_shift': 'float', 'scheme': 'OneOfExplicitTimeIntegrationTypeScheme', 'scheme_formulation': 'str', 'stop_on_cfl_criterion': 'bool', 'type': 'str'}¶
- property scheme¶
Gets the scheme of this ExplicitTimeIntegrationType. # noqa: E501
- Returns
The scheme of this ExplicitTimeIntegrationType. # noqa: E501
- Return type
OneOfExplicitTimeIntegrationTypeScheme
- property scheme_formulation¶
Gets the scheme_formulation of this ExplicitTimeIntegrationType. # noqa: E501
<p>Choose the primary variable for the time integration scheme.</p> # noqa: E501
- Returns
The scheme_formulation of this ExplicitTimeIntegrationType. # noqa: E501
- Return type
str
- property stop_on_cfl_criterion¶
Gets the stop_on_cfl_criterion of this ExplicitTimeIntegrationType. # noqa: E501
<p>If activated the simulation run is stopped when at some point the Courant-Friedrichs-Lewy (CFL) condition is violated.</p> # noqa: E501
- Returns
The stop_on_cfl_criterion of this ExplicitTimeIntegrationType. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ExplicitTimeIntegrationType. # noqa: E501
<p>Choose the time integration scheme type</p><br /><br />Important remarks:<br /><ul><li>Choose <b>implicit</b> if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme. </li><i>Choose <b>explicit</b> if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it’s not recommended due to convergence problems. </i></ul> Schema name: ExplicitTimeIntegrationType # noqa: E501
- Returns
The type of this ExplicitTimeIntegrationType. # noqa: E501
- Return type
str
simscale_sdk.models.expression_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.expression_function.ExpressionFunction(type='EXPRESSION', expression=None, available_variables=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'available_variables': 'availableVariables', 'expression': 'expression', 'type': 'type'}¶
- property available_variables¶
Gets the available_variables of this ExpressionFunction. # noqa: E501
- Returns
The available_variables of this ExpressionFunction. # noqa: E501
- Return type
list[FunctionParameter]
- property expression¶
Gets the expression of this ExpressionFunction. # noqa: E501
- Returns
The expression of this ExpressionFunction. # noqa: E501
- Return type
str
- openapi_types = {'available_variables': 'list[FunctionParameter]', 'expression': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ExpressionFunction. # noqa: E501
Schema name: ExpressionFunction # noqa: E501
- Returns
The type of this ExpressionFunction. # noqa: E501
- Return type
str
simscale_sdk.models.external_wall_heat_flux_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.external_wall_heat_flux_tbc.ExternalWallHeatFluxTBC(type='EXTERNAL_WALL_HEAT_FLUX_TEMPERATURE', heat_flux=None, value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heat_flux': 'heatFlux', 'type': 'type', 'value': 'value'}¶
- property heat_flux¶
Gets the heat_flux of this ExternalWallHeatFluxTBC. # noqa: E501
- Returns
The heat_flux of this ExternalWallHeatFluxTBC. # noqa: E501
- Return type
OneOfExternalWallHeatFluxTBCHeatFlux
- openapi_types = {'heat_flux': 'OneOfExternalWallHeatFluxTBCHeatFlux', 'type': 'str', 'value': 'DimensionalTemperature'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ExternalWallHeatFluxTBC. # noqa: E501
Schema name: ExternalWallHeatFluxTBC # noqa: E501
- Returns
The type of this ExternalWallHeatFluxTBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this ExternalWallHeatFluxTBC. # noqa: E501
- Returns
The value of this ExternalWallHeatFluxTBC. # noqa: E501
- Return type
simscale_sdk.models.fair_weather_conditions module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fair_weather_conditions.FairWeatherConditions(type='FAIR_WEATHER_CONDITIONS', sky_cloud_cover_fraction=None, ground_reflectivity=None, apparent_solar_irradiation=None, atmospheric_extinction_coefficient=None, diffuse_radiation_factor=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property apparent_solar_irradiation¶
Gets the apparent_solar_irradiation of this FairWeatherConditions. # noqa: E501
- Returns
The apparent_solar_irradiation of this FairWeatherConditions. # noqa: E501
- Return type
- property atmospheric_extinction_coefficient¶
Gets the atmospheric_extinction_coefficient of this FairWeatherConditions. # noqa: E501
Atmospheric extinction coefficient (B) # noqa: E501
- Returns
The atmospheric_extinction_coefficient of this FairWeatherConditions. # noqa: E501
- Return type
float
- attribute_map = {'apparent_solar_irradiation': 'apparentSolarIrradiation', 'atmospheric_extinction_coefficient': 'atmosphericExtinctionCoefficient', 'diffuse_radiation_factor': 'diffuseRadiationFactor', 'ground_reflectivity': 'groundReflectivity', 'sky_cloud_cover_fraction': 'skyCloudCoverFraction', 'type': 'type'}¶
- property diffuse_radiation_factor¶
Gets the diffuse_radiation_factor of this FairWeatherConditions. # noqa: E501
Diffuse radiation factor (C) # noqa: E501
- Returns
The diffuse_radiation_factor of this FairWeatherConditions. # noqa: E501
- Return type
float
- property ground_reflectivity¶
Gets the ground_reflectivity of this FairWeatherConditions. # noqa: E501
- Returns
The ground_reflectivity of this FairWeatherConditions. # noqa: E501
- Return type
float
- openapi_types = {'apparent_solar_irradiation': 'DimensionalHeatFlux', 'atmospheric_extinction_coefficient': 'float', 'diffuse_radiation_factor': 'float', 'ground_reflectivity': 'float', 'sky_cloud_cover_fraction': 'float', 'type': 'str'}¶
- property sky_cloud_cover_fraction¶
Gets the sky_cloud_cover_fraction of this FairWeatherConditions. # noqa: E501
- Returns
The sky_cloud_cover_fraction of this FairWeatherConditions. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FairWeatherConditions. # noqa: E501
Schema name: FairWeatherConditions # noqa: E501
- Returns
The type of this FairWeatherConditions. # noqa: E501
- Return type
str
simscale_sdk.models.false_change_jacobian_matrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.false_change_jacobian_matrix.FalseChangeJacobianMatrix(type='FALSE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FalseChangeJacobianMatrix. # noqa: E501
<p>Choose if the Jacobian matrix should automatically change from tangent stiffnes matrix to elastic matrix if the time increment is falling below a given threshold. On the assumption that below a given time increment value the nonlinearities are not evolving within the time step one can strongly save computation time by switching to the elastic matrix.</p> Schema name: FalseChangeJacobianMatrix # noqa: E501
- Returns
The type of this FalseChangeJacobianMatrix. # noqa: E501
- Return type
str
simscale_sdk.models.false_line_search module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.false_line_search.FalseLineSearch(type='FALSE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FalseLineSearch. # noqa: E501
<p>Line search can be used to improve convergence for nonlinear calculations with the Newton method.</p> Schema name: FalseLineSearch # noqa: E501
- Returns
The type of this FalseLineSearch. # noqa: E501
- Return type
str
simscale_sdk.models.false_semi_implicit module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.false_semi_implicit.FalseSemiImplicit(type='FALSE_SEMI_IMPLICIT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FalseSemiImplicit. # noqa: E501
Schema name: FalseSemiImplicit # noqa: E501
- Returns
The type of this FalseSemiImplicit. # noqa: E501
- Return type
str
simscale_sdk.models.fan_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fan_pbc.FanPBC(type='FAN_PRESSURE', fan_pressure=None, direction=None, environmental_total_pressure=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'direction': 'direction', 'environmental_total_pressure': 'environmentalTotalPressure', 'fan_pressure': 'fanPressure', 'type': 'type'}¶
- property direction¶
Gets the direction of this FanPBC. # noqa: E501
- Returns
The direction of this FanPBC. # noqa: E501
- Return type
str
- property environmental_total_pressure¶
Gets the environmental_total_pressure of this FanPBC. # noqa: E501
- Returns
The environmental_total_pressure of this FanPBC. # noqa: E501
- Return type
- property fan_pressure¶
Gets the fan_pressure of this FanPBC. # noqa: E501
- Returns
The fan_pressure of this FanPBC. # noqa: E501
- Return type
- openapi_types = {'direction': 'str', 'environmental_total_pressure': 'DimensionalPressure', 'fan_pressure': 'DimensionalFunctionPressure', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FanPBC. # noqa: E501
Schema name: FanPBC # noqa: E501
- Returns
The type of this FanPBC. # noqa: E501
- Return type
str
simscale_sdk.models.feature_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.feature_refinement.FeatureRefinement(type='FEATURE', name=None, included_angle=None, distance_refinement_levels=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distance_refinement_levels': 'distanceRefinementLevels', 'included_angle': 'includedAngle', 'name': 'name', 'type': 'type'}¶
- property distance_refinement_levels¶
Gets the distance_refinement_levels of this FeatureRefinement. # noqa: E501
<p>This dynamic table allows you to add refinements to the mesh associated with the features (e.g. edges) in a specific distance to the features. Therefore specify the distance in the left box and the associated refinement level on the right (the higher, the finer). The pair (0,0) would mean that a refinement with level 0 would be introduced directly at the features of the mesh.</p> # noqa: E501
- Returns
The distance_refinement_levels of this FeatureRefinement. # noqa: E501
- Return type
list[RefinementLevel]
- property included_angle¶
Gets the included_angle of this FeatureRefinement. # noqa: E501
- Returns
The included_angle of this FeatureRefinement. # noqa: E501
- Return type
- property name¶
Gets the name of this FeatureRefinement. # noqa: E501
- Returns
The name of this FeatureRefinement. # noqa: E501
- Return type
str
- openapi_types = {'distance_refinement_levels': 'list[RefinementLevel]', 'included_angle': 'DimensionalAngle', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FeatureRefinement. # noqa: E501
A <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#feature-refinement’ target=’_blank’><b>feature refinement</b></a> can be used to refine the geometry’s feature edges. All edges whose adjacent surface normals form an angle of less than 150° will be refined. Schema name: FeatureRefinement # noqa: E501
- Returns
The type of this FeatureRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.feature_refinement_hex_dominant_snappy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.feature_refinement_hex_dominant_snappy.FeatureRefinementHexDominantSnappy(type='FEATURE_HEX_DOMINANT_SNAPPY', name=None, distance_refinement_lengths=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distance_refinement_lengths': 'distanceRefinementLengths', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property distance_refinement_lengths¶
Gets the distance_refinement_lengths of this FeatureRefinementHexDominantSnappy. # noqa: E501
Specify the desired <b>target cell edge length</b> based on the <b>distance</b> to the feature edges. The edge and surface mesh will then be refined up until the specified distance in all directions from the edges. # noqa: E501
- Returns
The distance_refinement_lengths of this FeatureRefinementHexDominantSnappy. # noqa: E501
- Return type
list[RefinementLength]
- property name¶
Gets the name of this FeatureRefinementHexDominantSnappy. # noqa: E501
- Returns
The name of this FeatureRefinementHexDominantSnappy. # noqa: E501
- Return type
str
- openapi_types = {'distance_refinement_lengths': 'list[RefinementLength]', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FeatureRefinementHexDominantSnappy. # noqa: E501
- Returns
The topological_reference of this FeatureRefinementHexDominantSnappy. # noqa: E501
- Return type
- property type¶
Gets the type of this FeatureRefinementHexDominantSnappy. # noqa: E501
A <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#feature-refinement’ target=’_blank’><b>feature refinement</b></a> can be used to refine the geometry’s feature edges. All edges whose adjacent surface normals form an angle of less than 150° will be refined. Schema name: FeatureRefinementHexDominantSnappy # noqa: E501
- Returns
The type of this FeatureRefinementHexDominantSnappy. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_adjoint_sensitivities_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_adjoint_sensitivities_result_control.FieldCalculationsAdjointSensitivitiesResultControl(type='ADJOINT_SENSITIVITIES', name=None, compute_sensitivities_to=None, optimization_force_direction=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'compute_sensitivities_to': 'computeSensitivitiesTo', 'name': 'name', 'optimization_force_direction': 'optimizationForceDirection', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property compute_sensitivities_to¶
Gets the compute_sensitivities_to of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Returns
The compute_sensitivities_to of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Return type
str
- property name¶
Gets the name of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Return type
str
- openapi_types = {'compute_sensitivities_to': 'str', 'name': 'str', 'optimization_force_direction': 'DecimalVector', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property optimization_force_direction¶
Gets the optimization_force_direction of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Returns
The optimization_force_direction of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Returns
The topological_reference of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
Schema name: FieldCalculationsAdjointSensitivitiesResultControl # noqa: E501
- Returns
The type of this FieldCalculationsAdjointSensitivitiesResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_friction_velocity_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_friction_velocity_result_control.FieldCalculationsFrictionVelocityResultControl(type='FRICTION_VELOCITY_U_TAU', name=None, result_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'result_type': 'resultType', 'type': 'type'}¶
- property name¶
Gets the name of this FieldCalculationsFrictionVelocityResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsFrictionVelocityResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'result_type': 'FrictionVelocityResultType', 'type': 'str'}¶
- property result_type¶
Gets the result_type of this FieldCalculationsFrictionVelocityResultControl. # noqa: E501
- Returns
The result_type of this FieldCalculationsFrictionVelocityResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsFrictionVelocityResultControl. # noqa: E501
Schema name: FieldCalculationsFrictionVelocityResultControl # noqa: E501
- Returns
The type of this FieldCalculationsFrictionVelocityResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_pressure_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_pressure_result_control.FieldCalculationsPressureResultControl(type='PRESSURE', name=None, pressure_type=None, result_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'pressure_type': 'pressureType', 'result_type': 'resultType', 'type': 'type'}¶
- property name¶
Gets the name of this FieldCalculationsPressureResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsPressureResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'pressure_type': 'OneOfFieldCalculationsPressureResultControlPressureType', 'result_type': 'OneOfFieldCalculationsPressureResultControlResultType', 'type': 'str'}¶
- property pressure_type¶
Gets the pressure_type of this FieldCalculationsPressureResultControl. # noqa: E501
- Returns
The pressure_type of this FieldCalculationsPressureResultControl. # noqa: E501
- Return type
OneOfFieldCalculationsPressureResultControlPressureType
- property result_type¶
Gets the result_type of this FieldCalculationsPressureResultControl. # noqa: E501
- Returns
The result_type of this FieldCalculationsPressureResultControl. # noqa: E501
- Return type
OneOfFieldCalculationsPressureResultControlResultType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsPressureResultControl. # noqa: E501
Schema name: FieldCalculationsPressureResultControl # noqa: E501
- Returns
The type of this FieldCalculationsPressureResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_surface_normals_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_surface_normals_result_control.FieldCalculationsSurfaceNormalsResultControl(type='SURFACE_NORMALS', name=None, result_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'result_type': 'resultType', 'type': 'type'}¶
- property name¶
Gets the name of this FieldCalculationsSurfaceNormalsResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsSurfaceNormalsResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'result_type': 'SurfaceNormalsResultType', 'type': 'str'}¶
- property result_type¶
Gets the result_type of this FieldCalculationsSurfaceNormalsResultControl. # noqa: E501
- Returns
The result_type of this FieldCalculationsSurfaceNormalsResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsSurfaceNormalsResultControl. # noqa: E501
Schema name: FieldCalculationsSurfaceNormalsResultControl # noqa: E501
- Returns
The type of this FieldCalculationsSurfaceNormalsResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_thermal_comfort_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_thermal_comfort_result_control.FieldCalculationsThermalComfortResultControl(type='THERMAL_COMFORT', name=None, clothing_coefficient_factor=None, metabolic_rate_factor=None, relative_humidity_factor=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'clothing_coefficient_factor': 'clothingCoefficientFactor', 'metabolic_rate_factor': 'metabolicRateFactor', 'name': 'name', 'relative_humidity_factor': 'relativeHumidityFactor', 'type': 'type'}¶
- property clothing_coefficient_factor¶
Gets the clothing_coefficient_factor of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Returns
The clothing_coefficient_factor of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Return type
float
- property metabolic_rate_factor¶
Gets the metabolic_rate_factor of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Returns
The metabolic_rate_factor of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Return type
float
- property name¶
Gets the name of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Return type
str
- openapi_types = {'clothing_coefficient_factor': 'float', 'metabolic_rate_factor': 'float', 'name': 'str', 'relative_humidity_factor': 'float', 'type': 'str'}¶
- property relative_humidity_factor¶
Gets the relative_humidity_factor of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Returns
The relative_humidity_factor of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsThermalComfortResultControl. # noqa: E501
Schema name: FieldCalculationsThermalComfortResultControl # noqa: E501
- Returns
The type of this FieldCalculationsThermalComfortResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_turbulence_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_turbulence_result_control.FieldCalculationsTurbulenceResultControl(type='TURBULENCE', name=None, result_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'result_type': 'resultType', 'type': 'type'}¶
- property name¶
Gets the name of this FieldCalculationsTurbulenceResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsTurbulenceResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'result_type': 'OneOfFieldCalculationsTurbulenceResultControlResultType', 'type': 'str'}¶
- property result_type¶
Gets the result_type of this FieldCalculationsTurbulenceResultControl. # noqa: E501
- Returns
The result_type of this FieldCalculationsTurbulenceResultControl. # noqa: E501
- Return type
OneOfFieldCalculationsTurbulenceResultControlResultType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsTurbulenceResultControl. # noqa: E501
Schema name: FieldCalculationsTurbulenceResultControl # noqa: E501
- Returns
The type of this FieldCalculationsTurbulenceResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_velocity_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_velocity_result_control.FieldCalculationsVelocityResultControl(type='VELOCITY', name=None, result_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'result_type': 'resultType', 'type': 'type'}¶
- property name¶
Gets the name of this FieldCalculationsVelocityResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsVelocityResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'result_type': 'VorticityResultType', 'type': 'str'}¶
- property result_type¶
Gets the result_type of this FieldCalculationsVelocityResultControl. # noqa: E501
- Returns
The result_type of this FieldCalculationsVelocityResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsVelocityResultControl. # noqa: E501
Schema name: FieldCalculationsVelocityResultControl # noqa: E501
- Returns
The type of this FieldCalculationsVelocityResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_calculations_wall_fluxes_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_calculations_wall_fluxes_result_control.FieldCalculationsWallFluxesResultControl(type='WALL_FLUXES', name=None, result_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'result_type': 'resultType', 'type': 'type'}¶
- property name¶
Gets the name of this FieldCalculationsWallFluxesResultControl. # noqa: E501
- Returns
The name of this FieldCalculationsWallFluxesResultControl. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'result_type': 'WallShearStressResultType', 'type': 'str'}¶
- property result_type¶
Gets the result_type of this FieldCalculationsWallFluxesResultControl. # noqa: E501
- Returns
The result_type of this FieldCalculationsWallFluxesResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldCalculationsWallFluxesResultControl. # noqa: E501
Schema name: FieldCalculationsWallFluxesResultControl # noqa: E501
- Returns
The type of this FieldCalculationsWallFluxesResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.field_change_retiming_event module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_change_retiming_event.FieldChangeRetimingEvent(type='FIELD_CHANGE', field_selection=None, threshold_value=None, timestep_calculation_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_selection': 'fieldSelection', 'threshold_value': 'thresholdValue', 'timestep_calculation_type': 'timestepCalculationType', 'type': 'type'}¶
- property field_selection¶
Gets the field_selection of this FieldChangeRetimingEvent. # noqa: E501
- Returns
The field_selection of this FieldChangeRetimingEvent. # noqa: E501
- Return type
OneOfFieldChangeRetimingEventFieldSelection
- openapi_types = {'field_selection': 'OneOfFieldChangeRetimingEventFieldSelection', 'threshold_value': 'float', 'timestep_calculation_type': 'OneOfFieldChangeRetimingEventTimestepCalculationType', 'type': 'str'}¶
- property threshold_value¶
Gets the threshold_value of this FieldChangeRetimingEvent. # noqa: E501
<p>This value defines the maximum allowed change of the defined target field component within each time increment. If this threshold is exceeded the time step is adapted according to the selected settings in the Timestep Calculation Type.</p> # noqa: E501
- Returns
The threshold_value of this FieldChangeRetimingEvent. # noqa: E501
- Return type
float
- property timestep_calculation_type¶
Gets the timestep_calculation_type of this FieldChangeRetimingEvent. # noqa: E501
- Returns
The timestep_calculation_type of this FieldChangeRetimingEvent. # noqa: E501
- Return type
OneOfFieldChangeRetimingEventTimestepCalculationType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldChangeRetimingEvent. # noqa: E501
<p>Select the event for the time step adaptation. Currently there are four different events possible that trigger a time step adaptation:</p><ul><li><p><b>Error</b>: This is the case of a general error like for example non-convergence or singular matrix errors.</p></ul><ul><li><p><b>Collision</b>: This event is triggered if in a computation with physical contact a contact state change from open to closed is noticed. This time step adaptation is especially useful in dynamics to reduce the effect of artificial oscillations due to inexact collision detection.</p></ul><ul><li><p><b>Field Change</b>: The user can define the maximum delta that a field is allowed to change within one time step, if the defined threshold is exceeded the time step is adapted. This time stepping criteria is especially useful to capture material nonlinearitier more exact.</p></ul><ul><li><p><b>Non-monotonous residual</b>: This event is triggered if the residual has not been reduced within three iterations . This criteria is mostly used to reduce runtime by detecting diverging time steps before reaching the maximum number of allowed newton iterations.</p></ul> Schema name: FieldChangeRetimingEvent # noqa: E501
- Returns
The type of this FieldChangeRetimingEvent. # noqa: E501
- Return type
str
simscale_sdk.models.field_change_target_calculation_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.field_change_target_calculation_type.FieldChangeTargetCalculationType(type='FIELD_CHANGE_TARGET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FieldChangeTargetCalculationType. # noqa: E501
<p>Select how the time increments should be computed in case of an adaptation event. Currently four types are available (which may not all be available for every event):</p><ul><li><p><b>Manual</b>: Here the user defines fixed time step subdivision and augmentation settings.</p></ul><ul><li><p><b>Newton Iterations Target</b>: With this setting the user defines a target value for the Newton Iterations and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Field Change Target</b>: With this setting the user defines a target value for change of a specific field component within a time increment and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Mixed</b>: The mixed type uses a fixed subdivision and an automatic adaptation of the time step with a target value for the change of the selected field component.</p></ul> Schema name: FieldChangeTargetCalculationType # noqa: E501
- Returns
The type of this FieldChangeTargetCalculationType. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FieldChangeTargetCalculationType. # noqa: E501
- Returns
The value of this FieldChangeTargetCalculationType. # noqa: E501
- Return type
float
simscale_sdk.models.filters module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.filters.Filters(cutting_planes=None, iso_surfaces=None, iso_volumes=None, displacement=None, particle_traces=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cutting_planes': 'cuttingPlanes', 'displacement': 'displacement', 'iso_surfaces': 'isoSurfaces', 'iso_volumes': 'isoVolumes', 'particle_traces': 'particleTraces'}¶
- property cutting_planes¶
Gets the cutting_planes of this Filters. # noqa: E501
- Returns
The cutting_planes of this Filters. # noqa: E501
- Return type
list[CuttingPlane]
- property displacement¶
Gets the displacement of this Filters. # noqa: E501
- Returns
The displacement of this Filters. # noqa: E501
- Return type
- property iso_surfaces¶
Gets the iso_surfaces of this Filters. # noqa: E501
- Returns
The iso_surfaces of this Filters. # noqa: E501
- Return type
list[IsoSurface]
- property iso_volumes¶
Gets the iso_volumes of this Filters. # noqa: E501
- Returns
The iso_volumes of this Filters. # noqa: E501
- Return type
list[IsoVolume]
- openapi_types = {'cutting_planes': 'list[CuttingPlane]', 'displacement': 'Displacement', 'iso_surfaces': 'list[IsoSurface]', 'iso_volumes': 'list[IsoVolume]', 'particle_traces': 'list[ParticleTrace]'}¶
- property particle_traces¶
Gets the particle_traces of this Filters. # noqa: E501
- Returns
The particle_traces of this Filters. # noqa: E501
- Return type
list[ParticleTrace]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.first_mode module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.first_mode.FirstMode(type='FIRSTMODE', number_of_modes=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'number_of_modes': 'numberOfModes', 'type': 'type'}¶
- property number_of_modes¶
Gets the number_of_modes of this FirstMode. # noqa: E501
- Returns
The number_of_modes of this FirstMode. # noqa: E501
- Return type
int
- openapi_types = {'number_of_modes': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FirstMode. # noqa: E501
<p>Select how you want to control natural frequencies to be computed:</p> <li><i>First modes</i>: The first <i>Number of modes</i> will be searched and computed, in the order of low to high frequency.</li><li><i>Frequency range</i>: All the modes within the range of frequencies will be searched and computed. The frequency range is specified by a <i>Start frequency</i> and an <i>End frequency</i>.</li> Schema name: FirstMode # noqa: E501
- Returns
The type of this FirstMode. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_augmentation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_augmentation.FixedAugmentation(newton_iteration_threshold=None, timestep_augmentation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'newton_iteration_threshold': 'newtonIterationThreshold', 'timestep_augmentation': 'timestepAugmentation'}¶
- property newton_iteration_threshold¶
Gets the newton_iteration_threshold of this FixedAugmentation. # noqa: E501
<p><b>Newton Iteration threshold</b> defines the threshold below which the actual number of Newton Iterations has to fall in order to increase the time step by the percentage given by <b>Timestep Augmentation</b>.</p> # noqa: E501
- Returns
The newton_iteration_threshold of this FixedAugmentation. # noqa: E501
- Return type
int
- openapi_types = {'newton_iteration_threshold': 'int', 'timestep_augmentation': 'float'}¶
- property timestep_augmentation¶
Gets the timestep_augmentation of this FixedAugmentation. # noqa: E501
<p><b>Newton Iteration threshold</b> defines the threshold below which the actual number of Newton Iterations has to fall in order to increase the time step by the percentage given by <b>Timestep Augmentation</b>.</p> # noqa: E501
- Returns
The timestep_augmentation of this FixedAugmentation. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.fixed_coeff_medium module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_coeff_medium.FixedCoeffMedium(type='FIXED_COEFFICIENTS', name=None, alpha=None, beta=None, reference_density=None, orientation=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property alpha¶
Gets the alpha of this FixedCoeffMedium. # noqa: E501
- Returns
The alpha of this FixedCoeffMedium. # noqa: E501
- Return type
- attribute_map = {'alpha': 'alpha', 'beta': 'beta', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'orientation': 'orientation', 'reference_density': 'referenceDensity', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property beta¶
Gets the beta of this FixedCoeffMedium. # noqa: E501
- Returns
The beta of this FixedCoeffMedium. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this FixedCoeffMedium. # noqa: E501
- Returns
The geometry_primitive_uuids of this FixedCoeffMedium. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this FixedCoeffMedium. # noqa: E501
- Returns
The name of this FixedCoeffMedium. # noqa: E501
- Return type
str
- openapi_types = {'alpha': 'DimensionalVectorSpecificTurbulenceDissipationRate', 'beta': 'DimensionalVectorAbsorptivity', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'orientation': 'OneOfFixedCoeffMediumOrientation', 'reference_density': 'DimensionalDensity', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property orientation¶
Gets the orientation of this FixedCoeffMedium. # noqa: E501
- Returns
The orientation of this FixedCoeffMedium. # noqa: E501
- Return type
OneOfFixedCoeffMediumOrientation
- property reference_density¶
Gets the reference_density of this FixedCoeffMedium. # noqa: E501
- Returns
The reference_density of this FixedCoeffMedium. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FixedCoeffMedium. # noqa: E501
- Returns
The topological_reference of this FixedCoeffMedium. # noqa: E501
- Return type
- property type¶
Gets the type of this FixedCoeffMedium. # noqa: E501
Schema name: FixedCoeffMedium # noqa: E501
- Returns
The type of this FixedCoeffMedium. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_flux_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_flux_pbc.FixedFluxPBC(type='FIXED_FLUX_PRESSURE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedFluxPBC. # noqa: E501
Schema name: FixedFluxPBC # noqa: E501
- Returns
The type of this FixedFluxPBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_dvbc.FixedGradientDVBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientDVBC. # noqa: E501
- Returns
The gradient of this FixedGradientDVBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalEddyViscosityGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientDVBC. # noqa: E501
Schema name: FixedGradientDVBC # noqa: E501
- Returns
The type of this FixedGradientDVBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_ebc.FixedGradientEBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientEBC. # noqa: E501
- Returns
The gradient of this FixedGradientEBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalEpsilonGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientEBC. # noqa: E501
Schema name: FixedGradientEBC # noqa: E501
- Returns
The type of this FixedGradientEBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_evbc.FixedGradientEVBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientEVBC. # noqa: E501
- Returns
The gradient of this FixedGradientEVBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalEddyViscosityGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientEVBC. # noqa: E501
Schema name: FixedGradientEVBC # noqa: E501
- Returns
The type of this FixedGradientEVBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_evcbc.FixedGradientEVCBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientEVCBC. # noqa: E501
- Returns
The gradient of this FixedGradientEVCBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalEddyViscosityGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientEVCBC. # noqa: E501
Schema name: FixedGradientEVCBC # noqa: E501
- Returns
The type of this FixedGradientEVCBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_nbc.FixedGradientNBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientNBC. # noqa: E501
- Returns
The gradient of this FixedGradientNBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalSpeed', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientNBC. # noqa: E501
Schema name: FixedGradientNBC # noqa: E501
- Returns
The type of this FixedGradientNBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_obc.FixedGradientOBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientOBC. # noqa: E501
- Returns
The gradient of this FixedGradientOBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalSpecificTurbulenceDissipationRateGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientOBC. # noqa: E501
Schema name: FixedGradientOBC # noqa: E501
- Returns
The type of this FixedGradientOBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_pbc.FixedGradientPBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientPBC. # noqa: E501
- Returns
The gradient of this FixedGradientPBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalForceDensity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientPBC. # noqa: E501
Schema name: FixedGradientPBC # noqa: E501
- Returns
The type of this FixedGradientPBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_pfbc.FixedGradientPFBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientPFBC. # noqa: E501
- Returns
The gradient of this FixedGradientPFBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalPhaseFractionGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientPFBC. # noqa: E501
Schema name: FixedGradientPFBC # noqa: E501
- Returns
The type of this FixedGradientPFBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_psbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_psbc.FixedGradientPSBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientPSBC. # noqa: E501
- Returns
The gradient of this FixedGradientPSBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalAbsorptivity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientPSBC. # noqa: E501
Schema name: FixedGradientPSBC # noqa: E501
- Returns
The type of this FixedGradientPSBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_tbc.FixedGradientTBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientTBC. # noqa: E501
- Returns
The gradient of this FixedGradientTBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalFunctionTemperatureGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientTBC. # noqa: E501
Schema name: FixedGradientTBC # noqa: E501
- Returns
The type of this FixedGradientTBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_tdbc.FixedGradientTDBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientTDBC. # noqa: E501
- Returns
The gradient of this FixedGradientTDBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalEddyViscosityGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientTDBC. # noqa: E501
Schema name: FixedGradientTDBC # noqa: E501
- Returns
The type of this FixedGradientTDBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_tdcbc.FixedGradientTDCBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientTDCBC. # noqa: E501
- Returns
The gradient of this FixedGradientTDCBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalEddyViscosityGradient', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientTDCBC. # noqa: E501
Schema name: FixedGradientTDCBC # noqa: E501
- Returns
The type of this FixedGradientTDCBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_tkebc.FixedGradientTKEBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientTKEBC. # noqa: E501
- Returns
The gradient of this FixedGradientTKEBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalAcceleration', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientTKEBC. # noqa: E501
Schema name: FixedGradientTKEBC # noqa: E501
- Returns
The type of this FixedGradientTKEBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_gradient_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_gradient_vbc.FixedGradientVBC(type='FIXED_GRADIENT', gradient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gradient': 'gradient', 'type': 'type'}¶
- property gradient¶
Gets the gradient of this FixedGradientVBC. # noqa: E501
- Returns
The gradient of this FixedGradientVBC. # noqa: E501
- Return type
- openapi_types = {'gradient': 'DimensionalVectorSpecificTurbulenceDissipationRate', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedGradientVBC. # noqa: E501
Schema name: FixedGradientVBC # noqa: E501
- Returns
The type of this FixedGradientVBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_heat_flux module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_heat_flux.FixedHeatFlux(type='FIXED', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalHeatFlux'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedHeatFlux. # noqa: E501
Schema name: FixedHeatFlux # noqa: E501
- Returns
The type of this FixedHeatFlux. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedHeatFlux. # noqa: E501
- Returns
The value of this FixedHeatFlux. # noqa: E501
- Return type
simscale_sdk.models.fixed_magnitude_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_magnitude_vbc.FixedMagnitudeVBC(type='FIXED_VALUE_NO_EXPRESSION', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionSpeed'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedMagnitudeVBC. # noqa: E501
Schema name: FixedMagnitudeVBC # noqa: E501
- Returns
The type of this FixedMagnitudeVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedMagnitudeVBC. # noqa: E501
- Returns
The value of this FixedMagnitudeVBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_material_property module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_material_property.FixedMaterialProperty(name=None, unit=None, value_type='fixed', data_type=None, value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'data_type': 'dataType', 'name': 'name', 'unit': 'unit', 'value': 'value', 'value_type': 'valueType'}¶
- property data_type¶
Gets the data_type of this FixedMaterialProperty. # noqa: E501
- Returns
The data_type of this FixedMaterialProperty. # noqa: E501
- Return type
- property name¶
Gets the name of this FixedMaterialProperty. # noqa: E501
The material property name # noqa: E501
- Returns
The name of this FixedMaterialProperty. # noqa: E501
- Return type
str
- openapi_types = {'data_type': 'PropertyDataType', 'name': 'str', 'unit': 'str', 'value': 'object', 'value_type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this FixedMaterialProperty. # noqa: E501
The material property unit # noqa: E501
- Returns
The unit of this FixedMaterialProperty. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedMaterialProperty. # noqa: E501
The property value # noqa: E501
- Returns
The value of this FixedMaterialProperty. # noqa: E501
- Return type
object
- property value_type¶
Gets the value_type of this FixedMaterialProperty. # noqa: E501
- Returns
The value_type of this FixedMaterialProperty. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_point_contact_non_linearity_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_point_contact_non_linearity_resolution.FixedPointContactNonLinearityResolution(type='FIXED_POINT', iteration_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iteration_control': 'iterationControl', 'type': 'type'}¶
- property iteration_control¶
Gets the iteration_control of this FixedPointContactNonLinearityResolution. # noqa: E501
- Returns
The iteration_control of this FixedPointContactNonLinearityResolution. # noqa: E501
- Return type
OneOfFixedPointContactNonLinearityResolutionIterationControl
- openapi_types = {'iteration_control': 'OneOfFixedPointContactNonLinearityResolutionIterationControl', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedPointContactNonLinearityResolution. # noqa: E501
Schema name: FixedPointContactNonLinearityResolution # noqa: E501
- Returns
The type of this FixedPointContactNonLinearityResolution. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_point_friction_non_linearity_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_point_friction_non_linearity_resolution.FixedPointFrictionNonLinearityResolution(type='FIXED_POINT', max_num_iteration=None, iteration_criterion=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iteration_criterion': 'iterationCriterion', 'max_num_iteration': 'maxNumIteration', 'type': 'type'}¶
- property iteration_criterion¶
Gets the iteration_criterion of this FixedPointFrictionNonLinearityResolution. # noqa: E501
- Returns
The iteration_criterion of this FixedPointFrictionNonLinearityResolution. # noqa: E501
- Return type
float
- property max_num_iteration¶
Gets the max_num_iteration of this FixedPointFrictionNonLinearityResolution. # noqa: E501
- Returns
The max_num_iteration of this FixedPointFrictionNonLinearityResolution. # noqa: E501
- Return type
int
- openapi_types = {'iteration_criterion': 'float', 'max_num_iteration': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedPointFrictionNonLinearityResolution. # noqa: E501
Schema name: FixedPointFrictionNonLinearityResolution # noqa: E501
- Returns
The type of this FixedPointFrictionNonLinearityResolution. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_point_non_linearity_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_point_non_linearity_resolution.FixedPointNonLinearityResolution(type='FIXED_POINT', geometry_reactualization=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_reactualization': 'geometryReactualization', 'type': 'type'}¶
- property geometry_reactualization¶
Gets the geometry_reactualization of this FixedPointNonLinearityResolution. # noqa: E501
- Returns
The geometry_reactualization of this FixedPointNonLinearityResolution. # noqa: E501
- Return type
OneOfFixedPointNonLinearityResolutionGeometryReactualization
- openapi_types = {'geometry_reactualization': 'OneOfFixedPointNonLinearityResolutionGeometryReactualization', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedPointNonLinearityResolution. # noqa: E501
Schema name: FixedPointNonLinearityResolution # noqa: E501
- Returns
The type of this FixedPointNonLinearityResolution. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_power_heat_flux module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_power_heat_flux.FixedPowerHeatFlux(type='FIXED_POWER', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalPower'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedPowerHeatFlux. # noqa: E501
Schema name: FixedPowerHeatFlux # noqa: E501
- Returns
The type of this FixedPowerHeatFlux. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedPowerHeatFlux. # noqa: E501
- Returns
The value of this FixedPowerHeatFlux. # noqa: E501
- Return type
simscale_sdk.models.fixed_subdivision module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_subdivision.FixedSubdivision(num_subdivisions=None, max_subdivision_depth=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_subdivision_depth': 'maxSubdivisionDepth', 'num_subdivisions': 'numSubdivisions'}¶
- property max_subdivision_depth¶
Gets the max_subdivision_depth of this FixedSubdivision. # noqa: E501
<p>Define maximum depth of the timestep subdivisions. If this value is exceeded the computation will stop. Example: If this value is set to 3, the number of subdivisions to 2 and the initial time step length is set to 1 sec, than the maximum depth is reached after 3 consecutive subdivisions (e.g. a time step of 1/8 sec based on <i>1.(1/2)<sup>3</sup></i>).</p> # noqa: E501
- Returns
The max_subdivision_depth of this FixedSubdivision. # noqa: E501
- Return type
int
- property num_subdivisions¶
Gets the num_subdivisions of this FixedSubdivision. # noqa: E501
<p>Define the number of equal subdivisions of a time step in case of an adaptation event.</p> # noqa: E501
- Returns
The num_subdivisions of this FixedSubdivision. # noqa: E501
- Return type
int
- openapi_types = {'max_subdivision_depth': 'int', 'num_subdivisions': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.fixed_support_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_support_bc.FixedSupportBC(type='FIXED_SUPPORT', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this FixedSupportBC. # noqa: E501
- Returns
The name of this FixedSupportBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FixedSupportBC. # noqa: E501
- Returns
The topological_reference of this FixedSupportBC. # noqa: E501
- Return type
- property type¶
Gets the type of this FixedSupportBC. # noqa: E501
<p>If a <b>fixed support</b> boundary condition is used, all degrees of freedom of the selected entities are fixed at zero. This constraint is often used to model a fixation to the ground or an undeformable part.<br><a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/fixed-support-constraint-type/’ target’blank’>Learn more</a>.</p> Schema name: FixedSupportBC # noqa: E501
- Returns
The type of this FixedSupportBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_temperature_value_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_temperature_value_bc.FixedTemperatureValueBC(type='FIXED_TEMPERATURE_VALUE', name=None, temperature_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'temperature_value': 'temperatureValue', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this FixedTemperatureValueBC. # noqa: E501
- Returns
The name of this FixedTemperatureValueBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'temperature_value': 'DimensionalFunctionTemperature', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property temperature_value¶
Gets the temperature_value of this FixedTemperatureValueBC. # noqa: E501
- Returns
The temperature_value of this FixedTemperatureValueBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FixedTemperatureValueBC. # noqa: E501
- Returns
The topological_reference of this FixedTemperatureValueBC. # noqa: E501
- Return type
- property type¶
Gets the type of this FixedTemperatureValueBC. # noqa: E501
This is a boundary condition for the <b>temperature</b> variable. It prescribes the given temperature value on all selected groups.<br /><br />Important remarks: <br /><ul><li>Do not define a temperature and a heat flux boundary condition on the same group</li><li>Do not define the temperature on slave entities of <b>Contact Constraints</b> as they are constrained by the master temperature</li><li>You may define a <b>parameter dependent (x,y,z,t)</b> value by defining a formula or uploading a table (csv-file)</li></ul> Schema name: FixedTemperatureValueBC # noqa: E501
- Returns
The type of this FixedTemperatureValueBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_value_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_bc.FixedValueBC(type='FIXED_VALUE', name=None, displacement=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'displacement': 'displacement', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property displacement¶
Gets the displacement of this FixedValueBC. # noqa: E501
- Returns
The displacement of this FixedValueBC. # noqa: E501
- Return type
- property name¶
Gets the name of this FixedValueBC. # noqa: E501
- Returns
The name of this FixedValueBC. # noqa: E501
- Return type
str
- openapi_types = {'displacement': 'DimensionalPartialVectorFunctionLength', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FixedValueBC. # noqa: E501
- Returns
The topological_reference of this FixedValueBC. # noqa: E501
- Return type
- property type¶
Gets the type of this FixedValueBC. # noqa: E501
This is a boundary condition for the <b>displacement vector</b> variable. You can define prescribed values for the displacement of the assigned groups in every coordinate direction (x,y,z) or leave it unconstrained in order to let the entity move freely. <br /><br />Important remarks: <br /><ul><li>Choose 0 as value in order to fix your selection.</li><li>Do not constrain entities in directions where a load boundary condition is applied.</li><li>Do not constrain entities with multiple Dirichlet boundary conditions in one direction (overconstrained).</li><li>Do not constrain slave entities of <b>Contact Constraints</b> as they are constrained by the master in that direction (overconstrained).</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/fixed-value-boundary-condition-type/’ target=’_blank’>Learn more</a>. Schema name: FixedValueBC # noqa: E501
- Returns
The type of this FixedValueBC. # noqa: E501
- Return type
str
simscale_sdk.models.fixed_value_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_dvbc.FixedValueDVBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueDVBC. # noqa: E501
Schema name: FixedValueDVBC # noqa: E501
- Returns
The type of this FixedValueDVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueDVBC. # noqa: E501
- Returns
The value of this FixedValueDVBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_ebc.FixedValueEBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionTurbulentDissipation'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueEBC. # noqa: E501
Schema name: FixedValueEBC # noqa: E501
- Returns
The type of this FixedValueEBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueEBC. # noqa: E501
- Returns
The value of this FixedValueEBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_evbc.FixedValueEVBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueEVBC. # noqa: E501
Schema name: FixedValueEVBC # noqa: E501
- Returns
The type of this FixedValueEVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueEVBC. # noqa: E501
- Returns
The value of this FixedValueEVBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_evcbc.FixedValueEVCBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueEVCBC. # noqa: E501
Schema name: FixedValueEVCBC # noqa: E501
- Returns
The type of this FixedValueEVCBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueEVCBC. # noqa: E501
- Returns
The value of this FixedValueEVCBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_nbc.FixedValueNBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalKinematicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueNBC. # noqa: E501
Schema name: FixedValueNBC # noqa: E501
- Returns
The type of this FixedValueNBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueNBC. # noqa: E501
- Returns
The value of this FixedValueNBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_obc.FixedValueOBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionSpecificTurbulenceDissipationRate'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueOBC. # noqa: E501
Schema name: FixedValueOBC # noqa: E501
- Returns
The type of this FixedValueOBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueOBC. # noqa: E501
- Returns
The value of this FixedValueOBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_pbc.FixedValuePBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionPressure'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValuePBC. # noqa: E501
Schema name: FixedValuePBC # noqa: E501
- Returns
The type of this FixedValuePBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValuePBC. # noqa: E501
- Returns
The value of this FixedValuePBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_pfbc.FixedValuePFBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDimensionless'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValuePFBC. # noqa: E501
Schema name: FixedValuePFBC # noqa: E501
- Returns
The type of this FixedValuePFBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValuePFBC. # noqa: E501
- Returns
The value of this FixedValuePFBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_psbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_psbc.FixedValuePSBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDimensionless'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValuePSBC. # noqa: E501
Schema name: FixedValuePSBC # noqa: E501
- Returns
The type of this FixedValuePSBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValuePSBC. # noqa: E501
- Returns
The value of this FixedValuePSBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_tbc.FixedValueTBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionTemperature'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueTBC. # noqa: E501
Schema name: FixedValueTBC # noqa: E501
- Returns
The type of this FixedValueTBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueTBC. # noqa: E501
- Returns
The value of this FixedValueTBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_tdbc.FixedValueTDBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueTDBC. # noqa: E501
Schema name: FixedValueTDBC # noqa: E501
- Returns
The type of this FixedValueTDBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueTDBC. # noqa: E501
- Returns
The value of this FixedValueTDBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_tdcbc.FixedValueTDCBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueTDCBC. # noqa: E501
Schema name: FixedValueTDCBC # noqa: E501
- Returns
The type of this FixedValueTDCBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueTDCBC. # noqa: E501
- Returns
The value of this FixedValueTDCBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_tkebc.FixedValueTKEBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionTurbulenceKineticEnergy'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueTKEBC. # noqa: E501
Schema name: FixedValueTKEBC # noqa: E501
- Returns
The type of this FixedValueTKEBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueTKEBC. # noqa: E501
- Returns
The value of this FixedValueTKEBC. # noqa: E501
- Return type
simscale_sdk.models.fixed_value_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fixed_value_vbc.FixedValueVBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalVectorFunctionSpeed'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FixedValueVBC. # noqa: E501
Schema name: FixedValueVBC # noqa: E501
- Returns
The type of this FixedValueVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FixedValueVBC. # noqa: E501
- Returns
The value of this FixedValueVBC. # noqa: E501
- Return type
simscale_sdk.models.flow_dependent_value_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_dependent_value_pfbc.FlowDependentValuePFBC(type='FLOW_DEPENDENT_VALUE', lower_bound=None, upper_bound=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'lower_bound': 'lowerBound', 'type': 'type', 'upper_bound': 'upperBound'}¶
- property lower_bound¶
Gets the lower_bound of this FlowDependentValuePFBC. # noqa: E501
- Returns
The lower_bound of this FlowDependentValuePFBC. # noqa: E501
- Return type
float
- openapi_types = {'lower_bound': 'float', 'type': 'str', 'upper_bound': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FlowDependentValuePFBC. # noqa: E501
Schema name: FlowDependentValuePFBC # noqa: E501
- Returns
The type of this FlowDependentValuePFBC. # noqa: E501
- Return type
str
- property upper_bound¶
Gets the upper_bound of this FlowDependentValuePFBC. # noqa: E501
- Returns
The upper_bound of this FlowDependentValuePFBC. # noqa: E501
- Return type
float
simscale_sdk.models.flow_domain_boundaries module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_domain_boundaries.FlowDomainBoundaries(xmin=None, xmax=None, ymin=None, ymax=None, zmin=None, zmax=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'xmax': 'XMAX', 'xmin': 'XMIN', 'ymax': 'YMAX', 'ymin': 'YMIN', 'zmax': 'ZMAX', 'zmin': 'ZMIN'}¶
- openapi_types = {'xmax': 'OneOfFlowDomainBoundariesXMAX', 'xmin': 'OneOfFlowDomainBoundariesXMIN', 'ymax': 'OneOfFlowDomainBoundariesYMAX', 'ymin': 'OneOfFlowDomainBoundariesYMIN', 'zmax': 'OneOfFlowDomainBoundariesZMAX', 'zmin': 'OneOfFlowDomainBoundariesZMIN'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property xmax¶
Gets the xmax of this FlowDomainBoundaries. # noqa: E501
- Returns
The xmax of this FlowDomainBoundaries. # noqa: E501
- Return type
OneOfFlowDomainBoundariesXMAX
- property xmin¶
Gets the xmin of this FlowDomainBoundaries. # noqa: E501
- Returns
The xmin of this FlowDomainBoundaries. # noqa: E501
- Return type
OneOfFlowDomainBoundariesXMIN
- property ymax¶
Gets the ymax of this FlowDomainBoundaries. # noqa: E501
- Returns
The ymax of this FlowDomainBoundaries. # noqa: E501
- Return type
OneOfFlowDomainBoundariesYMAX
- property ymin¶
Gets the ymin of this FlowDomainBoundaries. # noqa: E501
- Returns
The ymin of this FlowDomainBoundaries. # noqa: E501
- Return type
OneOfFlowDomainBoundariesYMIN
- property zmax¶
Gets the zmax of this FlowDomainBoundaries. # noqa: E501
- Returns
The zmax of this FlowDomainBoundaries. # noqa: E501
- Return type
OneOfFlowDomainBoundariesZMAX
- property zmin¶
Gets the zmin of this FlowDomainBoundaries. # noqa: E501
- Returns
The zmin of this FlowDomainBoundaries. # noqa: E501
- Return type
OneOfFlowDomainBoundariesZMIN
simscale_sdk.models.flow_rate_inlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_rate_inlet_vbc.FlowRateInletVBC(type='FLOW_RATE_INLET_VELOCITY', flow_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flow_rate': 'flowRate', 'type': 'type'}¶
- property flow_rate¶
Gets the flow_rate of this FlowRateInletVBC. # noqa: E501
- Returns
The flow_rate of this FlowRateInletVBC. # noqa: E501
- Return type
OneOfFlowRateInletVBCFlowRate
- openapi_types = {'flow_rate': 'OneOfFlowRateInletVBCFlowRate', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FlowRateInletVBC. # noqa: E501
Schema name: FlowRateInletVBC # noqa: E501
- Returns
The type of this FlowRateInletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.flow_rate_mean_inlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_rate_mean_inlet_vbc.FlowRateMeanInletVBC(type='FLOW_RATE_MEAN_INLET_VELOCITY', flow_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flow_rate': 'flowRate', 'type': 'type'}¶
- property flow_rate¶
Gets the flow_rate of this FlowRateMeanInletVBC. # noqa: E501
- Returns
The flow_rate of this FlowRateMeanInletVBC. # noqa: E501
- Return type
OneOfFlowRateMeanInletVBCFlowRate
- openapi_types = {'flow_rate': 'OneOfFlowRateMeanInletVBCFlowRate', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FlowRateMeanInletVBC. # noqa: E501
Schema name: FlowRateMeanInletVBC # noqa: E501
- Returns
The type of this FlowRateMeanInletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.flow_rate_mean_outlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_rate_mean_outlet_vbc.FlowRateMeanOutletVBC(type='FLOW_RATE_MEAN_OUTLET_VELOCITY', flow_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flow_rate': 'flowRate', 'type': 'type'}¶
- property flow_rate¶
Gets the flow_rate of this FlowRateMeanOutletVBC. # noqa: E501
- Returns
The flow_rate of this FlowRateMeanOutletVBC. # noqa: E501
- Return type
OneOfFlowRateMeanOutletVBCFlowRate
- openapi_types = {'flow_rate': 'OneOfFlowRateMeanOutletVBCFlowRate', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FlowRateMeanOutletVBC. # noqa: E501
Schema name: FlowRateMeanOutletVBC # noqa: E501
- Returns
The type of this FlowRateMeanOutletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.flow_rate_outlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_rate_outlet_vbc.FlowRateOutletVBC(type='FLOW_RATE_OUTLET_VELOCITY', flow_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flow_rate': 'flowRate', 'type': 'type'}¶
- property flow_rate¶
Gets the flow_rate of this FlowRateOutletVBC. # noqa: E501
- Returns
The flow_rate of this FlowRateOutletVBC. # noqa: E501
- Return type
OneOfFlowRateOutletVBCFlowRate
- openapi_types = {'flow_rate': 'OneOfFlowRateOutletVBCFlowRate', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FlowRateOutletVBC. # noqa: E501
Schema name: FlowRateOutletVBC # noqa: E501
- Returns
The type of this FlowRateOutletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.flow_rate_stable_outlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flow_rate_stable_outlet_vbc.FlowRateStableOutletVBC(type='FLOW_RATE_STABLE_OUTLET_VELOCITY', flow_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flow_rate': 'flowRate', 'type': 'type'}¶
- property flow_rate¶
Gets the flow_rate of this FlowRateStableOutletVBC. # noqa: E501
- Returns
The flow_rate of this FlowRateStableOutletVBC. # noqa: E501
- Return type
OneOfFlowRateStableOutletVBCFlowRate
- openapi_types = {'flow_rate': 'OneOfFlowRateStableOutletVBCFlowRate', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FlowRateStableOutletVBC. # noqa: E501
Schema name: FlowRateStableOutletVBC # noqa: E501
- Returns
The type of this FlowRateStableOutletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.fluid_compressible_material module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_compressible_material.FluidCompressibleMaterial(type='COMPRESSIBLE', name=None, specie=None, transport=None, topological_reference=None, geometry_primitive_uuids=None, built_in_material=None, material_library_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'built_in_material': 'builtInMaterial', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'material_library_reference': 'materialLibraryReference', 'name': 'name', 'specie': 'specie', 'topological_reference': 'topologicalReference', 'transport': 'transport', 'type': 'type'}¶
- property built_in_material¶
Gets the built_in_material of this FluidCompressibleMaterial. # noqa: E501
- Returns
The built_in_material of this FluidCompressibleMaterial. # noqa: E501
- Return type
str
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this FluidCompressibleMaterial. # noqa: E501
- Returns
The geometry_primitive_uuids of this FluidCompressibleMaterial. # noqa: E501
- Return type
list[str]
- property material_library_reference¶
Gets the material_library_reference of this FluidCompressibleMaterial. # noqa: E501
- Returns
The material_library_reference of this FluidCompressibleMaterial. # noqa: E501
- Return type
- property name¶
Gets the name of this FluidCompressibleMaterial. # noqa: E501
- Returns
The name of this FluidCompressibleMaterial. # noqa: E501
- Return type
str
- openapi_types = {'built_in_material': 'str', 'geometry_primitive_uuids': 'list[str]', 'material_library_reference': 'MaterialLibraryReference', 'name': 'str', 'specie': 'SpecieDefault', 'topological_reference': 'TopologicalReference', 'transport': 'OneOfFluidCompressibleMaterialTransport', 'type': 'str'}¶
- property specie¶
Gets the specie of this FluidCompressibleMaterial. # noqa: E501
- Returns
The specie of this FluidCompressibleMaterial. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FluidCompressibleMaterial. # noqa: E501
- Returns
The topological_reference of this FluidCompressibleMaterial. # noqa: E501
- Return type
- property transport¶
Gets the transport of this FluidCompressibleMaterial. # noqa: E501
- Returns
The transport of this FluidCompressibleMaterial. # noqa: E501
- Return type
OneOfFluidCompressibleMaterialTransport
- property type¶
Gets the type of this FluidCompressibleMaterial. # noqa: E501
Schema name: FluidCompressibleMaterial # noqa: E501
- Returns
The type of this FluidCompressibleMaterial. # noqa: E501
- Return type
str
simscale_sdk.models.fluid_initial_conditions module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_initial_conditions.FluidInitialConditions(pressure=None, pressure_rgh=None, gauge_pressure=None, gauge_pressure_rgh=None, velocity=None, temperature=None, turbulent_kinetic_energy=None, omega_dissipation_rate=None, epsilon_dissipation_rate=None, eddy_viscosity=None, eddy_viscosity_multiphase=None, eddy_viscosity_compressible=None, nu_tilda=None, turbulent_thermal_diffusivity=None, turbulent_thermal_diffusivity_compressible=None, turbulent_dynamic_viscosity=None, passive_scalars=None, phase_fraction=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'eddy_viscosity': 'eddyViscosity', 'eddy_viscosity_compressible': 'eddyViscosityCompressible', 'eddy_viscosity_multiphase': 'eddyViscosityMultiphase', 'epsilon_dissipation_rate': 'epsilonDissipationRate', 'gauge_pressure': 'gaugePressure', 'gauge_pressure_rgh': 'gaugePressureRgh', 'nu_tilda': 'nuTilda', 'omega_dissipation_rate': 'omegaDissipationRate', 'passive_scalars': 'passiveScalars', 'phase_fraction': 'phaseFraction', 'pressure': 'pressure', 'pressure_rgh': 'pressureRgh', 'temperature': 'temperature', 'turbulent_dynamic_viscosity': 'turbulentDynamicViscosity', 'turbulent_kinetic_energy': 'turbulentKineticEnergy', 'turbulent_thermal_diffusivity': 'turbulentThermalDiffusivity', 'turbulent_thermal_diffusivity_compressible': 'turbulentThermalDiffusivityCompressible', 'velocity': 'velocity'}¶
- property eddy_viscosity¶
Gets the eddy_viscosity of this FluidInitialConditions. # noqa: E501
- Returns
The eddy_viscosity of this FluidInitialConditions. # noqa: E501
- Return type
- property eddy_viscosity_compressible¶
Gets the eddy_viscosity_compressible of this FluidInitialConditions. # noqa: E501
- Returns
The eddy_viscosity_compressible of this FluidInitialConditions. # noqa: E501
- Return type
- property eddy_viscosity_multiphase¶
Gets the eddy_viscosity_multiphase of this FluidInitialConditions. # noqa: E501
- Returns
The eddy_viscosity_multiphase of this FluidInitialConditions. # noqa: E501
- Return type
- property epsilon_dissipation_rate¶
Gets the epsilon_dissipation_rate of this FluidInitialConditions. # noqa: E501
- Returns
The epsilon_dissipation_rate of this FluidInitialConditions. # noqa: E501
- Return type
- property gauge_pressure¶
Gets the gauge_pressure of this FluidInitialConditions. # noqa: E501
- Returns
The gauge_pressure of this FluidInitialConditions. # noqa: E501
- Return type
- property gauge_pressure_rgh¶
Gets the gauge_pressure_rgh of this FluidInitialConditions. # noqa: E501
- Returns
The gauge_pressure_rgh of this FluidInitialConditions. # noqa: E501
- Return type
- property nu_tilda¶
Gets the nu_tilda of this FluidInitialConditions. # noqa: E501
- Returns
The nu_tilda of this FluidInitialConditions. # noqa: E501
- Return type
- property omega_dissipation_rate¶
Gets the omega_dissipation_rate of this FluidInitialConditions. # noqa: E501
- Returns
The omega_dissipation_rate of this FluidInitialConditions. # noqa: E501
- Return type
DimensionalInitialConditionDomainsSpecificTurbulenceDissipationRate
- openapi_types = {'eddy_viscosity': 'DimensionalInitialConditionDomainsDynamicViscosity', 'eddy_viscosity_compressible': 'DimensionalInitialConditionDomainsDynamicViscosity', 'eddy_viscosity_multiphase': 'DimensionalInitialConditionDomainsKinematicViscosity', 'epsilon_dissipation_rate': 'DimensionalInitialConditionDomainsTurbulentDissipation', 'gauge_pressure': 'DimensionalInitialConditionDomainsPressure', 'gauge_pressure_rgh': 'DimensionalInitialConditionDomainsPressure', 'nu_tilda': 'DimensionalInitialConditionDomainsKinematicViscosity', 'omega_dissipation_rate': 'DimensionalInitialConditionDomainsSpecificTurbulenceDissipationRate', 'passive_scalars': 'list[DimensionalInitialConditionDomainsDimensionless]', 'phase_fraction': 'DimensionalInitialConditionDomainsDimensionless', 'pressure': 'DimensionalInitialConditionDomainsPressure', 'pressure_rgh': 'DimensionalInitialConditionDomainsPressure', 'temperature': 'DimensionalInitialConditionDomainsTemperature', 'turbulent_dynamic_viscosity': 'DimensionalInitialConditionDomainsDynamicViscosity', 'turbulent_kinetic_energy': 'DimensionalInitialConditionDomainsTurbulenceKineticEnergy', 'turbulent_thermal_diffusivity': 'DimensionalInitialConditionDomainsDynamicViscosity', 'turbulent_thermal_diffusivity_compressible': 'DimensionalInitialConditionDomainsDynamicViscosity', 'velocity': 'DimensionalVectorInitialConditionDomainsSpeed'}¶
- property passive_scalars¶
Gets the passive_scalars of this FluidInitialConditions. # noqa: E501
- Returns
The passive_scalars of this FluidInitialConditions. # noqa: E501
- Return type
- property phase_fraction¶
Gets the phase_fraction of this FluidInitialConditions. # noqa: E501
- Returns
The phase_fraction of this FluidInitialConditions. # noqa: E501
- Return type
- property pressure¶
Gets the pressure of this FluidInitialConditions. # noqa: E501
- Returns
The pressure of this FluidInitialConditions. # noqa: E501
- Return type
- property pressure_rgh¶
Gets the pressure_rgh of this FluidInitialConditions. # noqa: E501
- Returns
The pressure_rgh of this FluidInitialConditions. # noqa: E501
- Return type
- property temperature¶
Gets the temperature of this FluidInitialConditions. # noqa: E501
- Returns
The temperature of this FluidInitialConditions. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulent_dynamic_viscosity¶
Gets the turbulent_dynamic_viscosity of this FluidInitialConditions. # noqa: E501
- Returns
The turbulent_dynamic_viscosity of this FluidInitialConditions. # noqa: E501
- Return type
- property turbulent_kinetic_energy¶
Gets the turbulent_kinetic_energy of this FluidInitialConditions. # noqa: E501
- Returns
The turbulent_kinetic_energy of this FluidInitialConditions. # noqa: E501
- Return type
- property turbulent_thermal_diffusivity¶
Gets the turbulent_thermal_diffusivity of this FluidInitialConditions. # noqa: E501
- Returns
The turbulent_thermal_diffusivity of this FluidInitialConditions. # noqa: E501
- Return type
- property turbulent_thermal_diffusivity_compressible¶
Gets the turbulent_thermal_diffusivity_compressible of this FluidInitialConditions. # noqa: E501
- Returns
The turbulent_thermal_diffusivity_compressible of this FluidInitialConditions. # noqa: E501
- Return type
- property velocity¶
Gets the velocity of this FluidInitialConditions. # noqa: E501
- Returns
The velocity of this FluidInitialConditions. # noqa: E501
- Return type
simscale_sdk.models.fluid_interface module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_interface.FluidInterface(type='FLUID_INTERFACE', connections=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'connections': 'connections', 'type': 'type'}¶
- property connections¶
Gets the connections of this FluidInterface. # noqa: E501
- Returns
The connections of this FluidInterface. # noqa: E501
- Return type
list[RegionInterface]
- openapi_types = {'connections': 'list[RegionInterface]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FluidInterface. # noqa: E501
Schema name: FluidInterface # noqa: E501
- Returns
The type of this FluidInterface. # noqa: E501
- Return type
str
simscale_sdk.models.fluid_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_model.FluidModel(turbulent_schmidt_number=None, diffusion_coefficients=None, delta_coefficient=None, gravity=None, surface_tension=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'delta_coefficient': 'deltaCoefficient', 'diffusion_coefficients': 'diffusionCoefficients', 'gravity': 'gravity', 'surface_tension': 'surfaceTension', 'turbulent_schmidt_number': 'turbulentSchmidtNumber'}¶
- property delta_coefficient¶
Gets the delta_coefficient of this FluidModel. # noqa: E501
- Returns
The delta_coefficient of this FluidModel. # noqa: E501
- Return type
OneOfFluidModelDeltaCoefficient
- property diffusion_coefficients¶
Gets the diffusion_coefficients of this FluidModel. # noqa: E501
- Returns
The diffusion_coefficients of this FluidModel. # noqa: E501
- Return type
- property gravity¶
Gets the gravity of this FluidModel. # noqa: E501
- Returns
The gravity of this FluidModel. # noqa: E501
- Return type
- openapi_types = {'delta_coefficient': 'OneOfFluidModelDeltaCoefficient', 'diffusion_coefficients': 'list[DimensionalKinematicViscosity]', 'gravity': 'DimensionalVectorAcceleration', 'surface_tension': 'DimensionalSurfaceTension', 'turbulent_schmidt_number': 'float'}¶
- property surface_tension¶
Gets the surface_tension of this FluidModel. # noqa: E501
- Returns
The surface_tension of this FluidModel. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulent_schmidt_number¶
Gets the turbulent_schmidt_number of this FluidModel. # noqa: E501
- Returns
The turbulent_schmidt_number of this FluidModel. # noqa: E501
- Return type
float
simscale_sdk.models.fluid_numerics module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_numerics.FluidNumerics(relaxation_type=None, relaxation_factor=None, radiation_resolution=None, momentum_predictor=None, transonic=None, num_outer_correctors=None, num_correctors=None, num_non_orthogonal_correctors=None, smoothing_parameter=None, damping_coefficient=None, num_alpha_spread_iterations=None, num_alpha_sweep_iterations=None, min_density=None, max_density=None, evaluate_turbulence_only_on_final_iteration=None, pressure_reference_cell=None, pressure_reference_value=None, velocity_limit=None, residual_controls=None, solvers=None, schemes=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'damping_coefficient': 'dampingCoefficient', 'evaluate_turbulence_only_on_final_iteration': 'evaluateTurbulenceOnlyOnFinalIteration', 'max_density': 'maxDensity', 'min_density': 'minDensity', 'momentum_predictor': 'momentumPredictor', 'num_alpha_spread_iterations': 'numAlphaSpreadIterations', 'num_alpha_sweep_iterations': 'numAlphaSweepIterations', 'num_correctors': 'numCorrectors', 'num_non_orthogonal_correctors': 'numNonOrthogonalCorrectors', 'num_outer_correctors': 'numOuterCorrectors', 'pressure_reference_cell': 'pressureReferenceCell', 'pressure_reference_value': 'pressureReferenceValue', 'radiation_resolution': 'radiationResolution', 'relaxation_factor': 'relaxationFactor', 'relaxation_type': 'relaxationType', 'residual_controls': 'residualControls', 'schemes': 'schemes', 'smoothing_parameter': 'smoothingParameter', 'solvers': 'solvers', 'transonic': 'transonic', 'velocity_limit': 'velocityLimit'}¶
- property damping_coefficient¶
Gets the damping_coefficient of this FluidNumerics. # noqa: E501
- Returns
The damping_coefficient of this FluidNumerics. # noqa: E501
- Return type
float
- property evaluate_turbulence_only_on_final_iteration¶
Gets the evaluate_turbulence_only_on_final_iteration of this FluidNumerics. # noqa: E501
- Returns
The evaluate_turbulence_only_on_final_iteration of this FluidNumerics. # noqa: E501
- Return type
bool
- property max_density¶
Gets the max_density of this FluidNumerics. # noqa: E501
- Returns
The max_density of this FluidNumerics. # noqa: E501
- Return type
- property min_density¶
Gets the min_density of this FluidNumerics. # noqa: E501
- Returns
The min_density of this FluidNumerics. # noqa: E501
- Return type
- property momentum_predictor¶
Gets the momentum_predictor of this FluidNumerics. # noqa: E501
- Returns
The momentum_predictor of this FluidNumerics. # noqa: E501
- Return type
bool
- property num_alpha_spread_iterations¶
Gets the num_alpha_spread_iterations of this FluidNumerics. # noqa: E501
- Returns
The num_alpha_spread_iterations of this FluidNumerics. # noqa: E501
- Return type
int
- property num_alpha_sweep_iterations¶
Gets the num_alpha_sweep_iterations of this FluidNumerics. # noqa: E501
- Returns
The num_alpha_sweep_iterations of this FluidNumerics. # noqa: E501
- Return type
int
- property num_correctors¶
Gets the num_correctors of this FluidNumerics. # noqa: E501
- Returns
The num_correctors of this FluidNumerics. # noqa: E501
- Return type
int
- property num_non_orthogonal_correctors¶
Gets the num_non_orthogonal_correctors of this FluidNumerics. # noqa: E501
<p>The pressure equation is repeatedly solved based on the value of non-orthogonal correctors in the PISO/SIMPLE/PIMPLE algorithm. This may reduce the effect of bad mesh.</p> # noqa: E501
- Returns
The num_non_orthogonal_correctors of this FluidNumerics. # noqa: E501
- Return type
int
- property num_outer_correctors¶
Gets the num_outer_correctors of this FluidNumerics. # noqa: E501
- Returns
The num_outer_correctors of this FluidNumerics. # noqa: E501
- Return type
int
- openapi_types = {'damping_coefficient': 'float', 'evaluate_turbulence_only_on_final_iteration': 'bool', 'max_density': 'DimensionalDensity', 'min_density': 'DimensionalDensity', 'momentum_predictor': 'bool', 'num_alpha_spread_iterations': 'int', 'num_alpha_sweep_iterations': 'int', 'num_correctors': 'int', 'num_non_orthogonal_correctors': 'int', 'num_outer_correctors': 'int', 'pressure_reference_cell': 'int', 'pressure_reference_value': 'DimensionalPressure', 'radiation_resolution': 'str', 'relaxation_factor': 'RelaxationFactor', 'relaxation_type': 'str', 'residual_controls': 'ResidualControls', 'schemes': 'Schemes', 'smoothing_parameter': 'float', 'solvers': 'FluidSolvers', 'transonic': 'bool', 'velocity_limit': 'DimensionalSpeed'}¶
- property pressure_reference_cell¶
Gets the pressure_reference_cell of this FluidNumerics. # noqa: E501
<p>Enter the cell where you want to define reference pressure in the PISO/SIMPLE/PIMPLE algorithm.</p> # noqa: E501
- Returns
The pressure_reference_cell of this FluidNumerics. # noqa: E501
- Return type
int
- property pressure_reference_value¶
Gets the pressure_reference_value of this FluidNumerics. # noqa: E501
- Returns
The pressure_reference_value of this FluidNumerics. # noqa: E501
- Return type
- property radiation_resolution¶
Gets the radiation_resolution of this FluidNumerics. # noqa: E501
- Returns
The radiation_resolution of this FluidNumerics. # noqa: E501
- Return type
str
- property relaxation_factor¶
Gets the relaxation_factor of this FluidNumerics. # noqa: E501
- Returns
The relaxation_factor of this FluidNumerics. # noqa: E501
- Return type
- property relaxation_type¶
Gets the relaxation_type of this FluidNumerics. # noqa: E501
- Returns
The relaxation_type of this FluidNumerics. # noqa: E501
- Return type
str
- property residual_controls¶
Gets the residual_controls of this FluidNumerics. # noqa: E501
- Returns
The residual_controls of this FluidNumerics. # noqa: E501
- Return type
- property schemes¶
Gets the schemes of this FluidNumerics. # noqa: E501
- Returns
The schemes of this FluidNumerics. # noqa: E501
- Return type
- property smoothing_parameter¶
Gets the smoothing_parameter of this FluidNumerics. # noqa: E501
- Returns
The smoothing_parameter of this FluidNumerics. # noqa: E501
- Return type
float
- property solvers¶
Gets the solvers of this FluidNumerics. # noqa: E501
- Returns
The solvers of this FluidNumerics. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property transonic¶
Gets the transonic of this FluidNumerics. # noqa: E501
- Returns
The transonic of this FluidNumerics. # noqa: E501
- Return type
bool
- property velocity_limit¶
Gets the velocity_limit of this FluidNumerics. # noqa: E501
- Returns
The velocity_limit of this FluidNumerics. # noqa: E501
- Return type
simscale_sdk.models.fluid_result_controls module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_result_controls.FluidResultControls(forces_moments=None, surface_data=None, scalar_transport=None, probe_points=None, field_calculations=None, transient_result_control=None, statistical_averaging_result_control=None, snapshot_result_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_calculations': 'fieldCalculations', 'forces_moments': 'forcesMoments', 'probe_points': 'probePoints', 'scalar_transport': 'scalarTransport', 'snapshot_result_control': 'snapshotResultControl', 'statistical_averaging_result_control': 'statisticalAveragingResultControl', 'surface_data': 'surfaceData', 'transient_result_control': 'transientResultControl'}¶
- property field_calculations¶
Gets the field_calculations of this FluidResultControls. # noqa: E501
- Returns
The field_calculations of this FluidResultControls. # noqa: E501
- Return type
list[OneOfFluidResultControlsFieldCalculations]
- property forces_moments¶
Gets the forces_moments of this FluidResultControls. # noqa: E501
- Returns
The forces_moments of this FluidResultControls. # noqa: E501
- Return type
list[OneOfFluidResultControlsForcesMoments]
- openapi_types = {'field_calculations': 'list[OneOfFluidResultControlsFieldCalculations]', 'forces_moments': 'list[OneOfFluidResultControlsForcesMoments]', 'probe_points': 'list[ProbePointsResultControl]', 'scalar_transport': 'list[ScalarTransportResultControl]', 'snapshot_result_control': 'SnapshotResultControl', 'statistical_averaging_result_control': 'StatisticalAveragingResultControlV2', 'surface_data': 'list[OneOfFluidResultControlsSurfaceData]', 'transient_result_control': 'TransientResultControl'}¶
- property probe_points¶
Gets the probe_points of this FluidResultControls. # noqa: E501
- Returns
The probe_points of this FluidResultControls. # noqa: E501
- Return type
list[ProbePointsResultControl]
- property scalar_transport¶
Gets the scalar_transport of this FluidResultControls. # noqa: E501
- Returns
The scalar_transport of this FluidResultControls. # noqa: E501
- Return type
- property snapshot_result_control¶
Gets the snapshot_result_control of this FluidResultControls. # noqa: E501
- Returns
The snapshot_result_control of this FluidResultControls. # noqa: E501
- Return type
- property statistical_averaging_result_control¶
Gets the statistical_averaging_result_control of this FluidResultControls. # noqa: E501
- Returns
The statistical_averaging_result_control of this FluidResultControls. # noqa: E501
- Return type
- property surface_data¶
Gets the surface_data of this FluidResultControls. # noqa: E501
- Returns
The surface_data of this FluidResultControls. # noqa: E501
- Return type
list[OneOfFluidResultControlsSurfaceData]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property transient_result_control¶
Gets the transient_result_control of this FluidResultControls. # noqa: E501
- Returns
The transient_result_control of this FluidResultControls. # noqa: E501
- Return type
simscale_sdk.models.fluid_simulation_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_simulation_control.FluidSimulationControl(end_time=None, adjoint_end_time=None, number_of_iterations=None, delta_t=None, adjustable_timestep=None, write_control=None, num_processors=None, max_run_time=None, potential_foam_initialization=None, decompose_algorithm=None, relative_convergence_criteria=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property adjoint_end_time¶
Gets the adjoint_end_time of this FluidSimulationControl. # noqa: E501
- Returns
The adjoint_end_time of this FluidSimulationControl. # noqa: E501
- Return type
- property adjustable_timestep¶
Gets the adjustable_timestep of this FluidSimulationControl. # noqa: E501
- Returns
The adjustable_timestep of this FluidSimulationControl. # noqa: E501
- Return type
OneOfFluidSimulationControlAdjustableTimestep
- attribute_map = {'adjoint_end_time': 'adjointEndTime', 'adjustable_timestep': 'adjustableTimestep', 'decompose_algorithm': 'decomposeAlgorithm', 'delta_t': 'deltaT', 'end_time': 'endTime', 'max_run_time': 'maxRunTime', 'num_processors': 'numProcessors', 'number_of_iterations': 'numberOfIterations', 'potential_foam_initialization': 'potentialFoamInitialization', 'relative_convergence_criteria': 'relativeConvergenceCriteria', 'write_control': 'writeControl'}¶
- property decompose_algorithm¶
Gets the decompose_algorithm of this FluidSimulationControl. # noqa: E501
- Returns
The decompose_algorithm of this FluidSimulationControl. # noqa: E501
- Return type
OneOfFluidSimulationControlDecomposeAlgorithm
- property delta_t¶
Gets the delta_t of this FluidSimulationControl. # noqa: E501
- Returns
The delta_t of this FluidSimulationControl. # noqa: E501
- Return type
- property end_time¶
Gets the end_time of this FluidSimulationControl. # noqa: E501
- Returns
The end_time of this FluidSimulationControl. # noqa: E501
- Return type
- property max_run_time¶
Gets the max_run_time of this FluidSimulationControl. # noqa: E501
- Returns
The max_run_time of this FluidSimulationControl. # noqa: E501
- Return type
- property num_processors¶
Gets the num_processors of this FluidSimulationControl. # noqa: E501
<p>Selecting more processor cores will speed up the simulation process. Choosing a smaller computation instance will save core hours. <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control-fluid/#number-of-processors’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The num_processors of this FluidSimulationControl. # noqa: E501
- Return type
int
- property number_of_iterations¶
Gets the number_of_iterations of this FluidSimulationControl. # noqa: E501
<b>Steady-state simulation:</b> This represents the number of total iterations at which the termination of simulation happens. No more iterations will be executed beyond that. <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control/’ target=’_blank’>Learn more</a>.<br> <b>Transient simulation:</b> This represents the number of iterations per time step. The recommended value is 25. The larger the <i>Delta t</i> value is, the larger the <i>Number of iterations</i> has to be, in order to obtain more stable, converged solution. The simulation will terminate only when the <i>End time</i> is reached.</br> # noqa: E501
- Returns
The number_of_iterations of this FluidSimulationControl. # noqa: E501
- Return type
int
- openapi_types = {'adjoint_end_time': 'DimensionalTime', 'adjustable_timestep': 'OneOfFluidSimulationControlAdjustableTimestep', 'decompose_algorithm': 'OneOfFluidSimulationControlDecomposeAlgorithm', 'delta_t': 'DimensionalTime', 'end_time': 'DimensionalTime', 'max_run_time': 'DimensionalTime', 'num_processors': 'int', 'number_of_iterations': 'int', 'potential_foam_initialization': 'bool', 'relative_convergence_criteria': 'float', 'write_control': 'OneOfFluidSimulationControlWriteControl'}¶
- property potential_foam_initialization¶
Gets the potential_foam_initialization of this FluidSimulationControl. # noqa: E501
This setting activates the solution of a potential flow field. The potential flow is used as initial condition for the actual simulation. This can accelerate convergence and improve stability during the first time steps. If you experience stability problems, this setting may bring some improvement. # noqa: E501
- Returns
The potential_foam_initialization of this FluidSimulationControl. # noqa: E501
- Return type
bool
- property relative_convergence_criteria¶
Gets the relative_convergence_criteria of this FluidSimulationControl. # noqa: E501
<b>Steady-state simulation:</b> This represents the relative error residuals that once attained by the solver the simulation is considered to be converged and will stop. The recommended value is 0.001.<br> <b>Transient simulation:</b> This represents the relative error residuals that once attained by the solver the simulation will move to the next time-step regardless of the <i>Number of iterations</i>. The recommended value is 0.1.</br> <br> <b>Please note: </b>Relative residual is defined as the residual in the current iteration divided by the initial residual.</br> <br> <b>Please note: </b>Lower convergence criterion is demanded for <b>Steady-state simulations</b> because the initial guess is typically farther from the correct solution.</br> # noqa: E501
- Returns
The relative_convergence_criteria of this FluidSimulationControl. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property write_control¶
Gets the write_control of this FluidSimulationControl. # noqa: E501
- Returns
The write_control of this FluidSimulationControl. # noqa: E501
- Return type
OneOfFluidSimulationControlWriteControl
simscale_sdk.models.fluid_solvers module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fluid_solvers.FluidSolvers(phase_fraction_solver=None, velocity_solver=None, velocity_final_solver=None, density_solver=None, density_final_solver=None, pressure_solver=None, pressure_final_solver=None, temperature_solver=None, temperature_final_solver=None, pressure_rgh_solver=None, pressure_rgh_final_solver=None, solid_enthalpy_solver=None, solid_enthalpy_final_solver=None, enthalpy_solver=None, enthalpy_final_solver=None, internal_energy_solver=None, internal_energy_final_solver=None, turbulent_kinetic_energy_solver=None, turbulent_kinetic_energy_final_solver=None, nu_tilda_solver=None, nu_tilda_final_solver=None, omega_dissipation_rate_solver=None, omega_dissipation_rate_final_solver=None, epsilon_dissipation_rate_solver=None, epsilon_dissipation_rate_final_solver=None, passive_scalar_solver=None, radiative_intensity_ray_solver=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'density_final_solver': 'densityFinalSolver', 'density_solver': 'densitySolver', 'enthalpy_final_solver': 'enthalpyFinalSolver', 'enthalpy_solver': 'enthalpySolver', 'epsilon_dissipation_rate_final_solver': 'epsilonDissipationRateFinalSolver', 'epsilon_dissipation_rate_solver': 'epsilonDissipationRateSolver', 'internal_energy_final_solver': 'internalEnergyFinalSolver', 'internal_energy_solver': 'internalEnergySolver', 'nu_tilda_final_solver': 'nuTildaFinalSolver', 'nu_tilda_solver': 'nuTildaSolver', 'omega_dissipation_rate_final_solver': 'omegaDissipationRateFinalSolver', 'omega_dissipation_rate_solver': 'omegaDissipationRateSolver', 'passive_scalar_solver': 'passiveScalarSolver', 'phase_fraction_solver': 'phaseFractionSolver', 'pressure_final_solver': 'pressureFinalSolver', 'pressure_rgh_final_solver': 'pressureRghFinalSolver', 'pressure_rgh_solver': 'pressureRghSolver', 'pressure_solver': 'pressureSolver', 'radiative_intensity_ray_solver': 'radiativeIntensityRaySolver', 'solid_enthalpy_final_solver': 'solidEnthalpyFinalSolver', 'solid_enthalpy_solver': 'solidEnthalpySolver', 'temperature_final_solver': 'temperatureFinalSolver', 'temperature_solver': 'temperatureSolver', 'turbulent_kinetic_energy_final_solver': 'turbulentKineticEnergyFinalSolver', 'turbulent_kinetic_energy_solver': 'turbulentKineticEnergySolver', 'velocity_final_solver': 'velocityFinalSolver', 'velocity_solver': 'velocitySolver'}¶
- property density_final_solver¶
Gets the density_final_solver of this FluidSolvers. # noqa: E501
- Returns
The density_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversDensityFinalSolver
- property density_solver¶
Gets the density_solver of this FluidSolvers. # noqa: E501
- Returns
The density_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversDensitySolver
- property enthalpy_final_solver¶
Gets the enthalpy_final_solver of this FluidSolvers. # noqa: E501
- Returns
The enthalpy_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversEnthalpyFinalSolver
- property enthalpy_solver¶
Gets the enthalpy_solver of this FluidSolvers. # noqa: E501
- Returns
The enthalpy_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversEnthalpySolver
- property epsilon_dissipation_rate_final_solver¶
Gets the epsilon_dissipation_rate_final_solver of this FluidSolvers. # noqa: E501
- Returns
The epsilon_dissipation_rate_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversEpsilonDissipationRateFinalSolver
- property epsilon_dissipation_rate_solver¶
Gets the epsilon_dissipation_rate_solver of this FluidSolvers. # noqa: E501
- Returns
The epsilon_dissipation_rate_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversEpsilonDissipationRateSolver
- property internal_energy_final_solver¶
Gets the internal_energy_final_solver of this FluidSolvers. # noqa: E501
- Returns
The internal_energy_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversInternalEnergyFinalSolver
- property internal_energy_solver¶
Gets the internal_energy_solver of this FluidSolvers. # noqa: E501
- Returns
The internal_energy_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversInternalEnergySolver
- property nu_tilda_final_solver¶
Gets the nu_tilda_final_solver of this FluidSolvers. # noqa: E501
- Returns
The nu_tilda_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversNuTildaFinalSolver
- property nu_tilda_solver¶
Gets the nu_tilda_solver of this FluidSolvers. # noqa: E501
- Returns
The nu_tilda_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversNuTildaSolver
- property omega_dissipation_rate_final_solver¶
Gets the omega_dissipation_rate_final_solver of this FluidSolvers. # noqa: E501
- Returns
The omega_dissipation_rate_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversOmegaDissipationRateFinalSolver
- property omega_dissipation_rate_solver¶
Gets the omega_dissipation_rate_solver of this FluidSolvers. # noqa: E501
- Returns
The omega_dissipation_rate_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversOmegaDissipationRateSolver
- openapi_types = {'density_final_solver': 'OneOfFluidSolversDensityFinalSolver', 'density_solver': 'OneOfFluidSolversDensitySolver', 'enthalpy_final_solver': 'OneOfFluidSolversEnthalpyFinalSolver', 'enthalpy_solver': 'OneOfFluidSolversEnthalpySolver', 'epsilon_dissipation_rate_final_solver': 'OneOfFluidSolversEpsilonDissipationRateFinalSolver', 'epsilon_dissipation_rate_solver': 'OneOfFluidSolversEpsilonDissipationRateSolver', 'internal_energy_final_solver': 'OneOfFluidSolversInternalEnergyFinalSolver', 'internal_energy_solver': 'OneOfFluidSolversInternalEnergySolver', 'nu_tilda_final_solver': 'OneOfFluidSolversNuTildaFinalSolver', 'nu_tilda_solver': 'OneOfFluidSolversNuTildaSolver', 'omega_dissipation_rate_final_solver': 'OneOfFluidSolversOmegaDissipationRateFinalSolver', 'omega_dissipation_rate_solver': 'OneOfFluidSolversOmegaDissipationRateSolver', 'passive_scalar_solver': 'OneOfFluidSolversPassiveScalarSolver', 'phase_fraction_solver': 'MULESSolver', 'pressure_final_solver': 'OneOfFluidSolversPressureFinalSolver', 'pressure_rgh_final_solver': 'OneOfFluidSolversPressureRghFinalSolver', 'pressure_rgh_solver': 'OneOfFluidSolversPressureRghSolver', 'pressure_solver': 'OneOfFluidSolversPressureSolver', 'radiative_intensity_ray_solver': 'OneOfFluidSolversRadiativeIntensityRaySolver', 'solid_enthalpy_final_solver': 'OneOfFluidSolversSolidEnthalpyFinalSolver', 'solid_enthalpy_solver': 'OneOfFluidSolversSolidEnthalpySolver', 'temperature_final_solver': 'OneOfFluidSolversTemperatureFinalSolver', 'temperature_solver': 'OneOfFluidSolversTemperatureSolver', 'turbulent_kinetic_energy_final_solver': 'OneOfFluidSolversTurbulentKineticEnergyFinalSolver', 'turbulent_kinetic_energy_solver': 'OneOfFluidSolversTurbulentKineticEnergySolver', 'velocity_final_solver': 'OneOfFluidSolversVelocityFinalSolver', 'velocity_solver': 'OneOfFluidSolversVelocitySolver'}¶
- property passive_scalar_solver¶
Gets the passive_scalar_solver of this FluidSolvers. # noqa: E501
- Returns
The passive_scalar_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversPassiveScalarSolver
- property phase_fraction_solver¶
Gets the phase_fraction_solver of this FluidSolvers. # noqa: E501
- Returns
The phase_fraction_solver of this FluidSolvers. # noqa: E501
- Return type
- property pressure_final_solver¶
Gets the pressure_final_solver of this FluidSolvers. # noqa: E501
- Returns
The pressure_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversPressureFinalSolver
- property pressure_rgh_final_solver¶
Gets the pressure_rgh_final_solver of this FluidSolvers. # noqa: E501
- Returns
The pressure_rgh_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversPressureRghFinalSolver
- property pressure_rgh_solver¶
Gets the pressure_rgh_solver of this FluidSolvers. # noqa: E501
- Returns
The pressure_rgh_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversPressureRghSolver
- property pressure_solver¶
Gets the pressure_solver of this FluidSolvers. # noqa: E501
- Returns
The pressure_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversPressureSolver
- property radiative_intensity_ray_solver¶
Gets the radiative_intensity_ray_solver of this FluidSolvers. # noqa: E501
- Returns
The radiative_intensity_ray_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversRadiativeIntensityRaySolver
- property solid_enthalpy_final_solver¶
Gets the solid_enthalpy_final_solver of this FluidSolvers. # noqa: E501
- Returns
The solid_enthalpy_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversSolidEnthalpyFinalSolver
- property solid_enthalpy_solver¶
Gets the solid_enthalpy_solver of this FluidSolvers. # noqa: E501
- Returns
The solid_enthalpy_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversSolidEnthalpySolver
- property temperature_final_solver¶
Gets the temperature_final_solver of this FluidSolvers. # noqa: E501
- Returns
The temperature_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversTemperatureFinalSolver
- property temperature_solver¶
Gets the temperature_solver of this FluidSolvers. # noqa: E501
- Returns
The temperature_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversTemperatureSolver
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulent_kinetic_energy_final_solver¶
Gets the turbulent_kinetic_energy_final_solver of this FluidSolvers. # noqa: E501
- Returns
The turbulent_kinetic_energy_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversTurbulentKineticEnergyFinalSolver
- property turbulent_kinetic_energy_solver¶
Gets the turbulent_kinetic_energy_solver of this FluidSolvers. # noqa: E501
- Returns
The turbulent_kinetic_energy_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversTurbulentKineticEnergySolver
- property velocity_final_solver¶
Gets the velocity_final_solver of this FluidSolvers. # noqa: E501
- Returns
The velocity_final_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversVelocityFinalSolver
- property velocity_solver¶
Gets the velocity_solver of this FluidSolvers. # noqa: E501
- Returns
The velocity_solver of this FluidSolvers. # noqa: E501
- Return type
OneOfFluidSolversVelocitySolver
simscale_sdk.models.flux_heat_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flux_heat_source.FluxHeatSource(type='FLUX', heat_flux=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heat_flux': 'heatFlux', 'type': 'type'}¶
- property heat_flux¶
Gets the heat_flux of this FluxHeatSource. # noqa: E501
- Returns
The heat_flux of this FluxHeatSource. # noqa: E501
- Return type
- openapi_types = {'heat_flux': 'DimensionalHeatFlux', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FluxHeatSource. # noqa: E501
Schema name: FluxHeatSource # noqa: E501
- Returns
The type of this FluxHeatSource. # noqa: E501
- Return type
str
simscale_sdk.models.flux_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.flux_schemes.FluxSchemes(for_default=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'for_default': 'forDefault'}¶
- property for_default¶
Gets the for_default of this FluxSchemes. # noqa: E501
- Returns
The for_default of this FluxSchemes. # noqa: E501
- Return type
OneOfFluxSchemesForDefault
- openapi_types = {'for_default': 'OneOfFluxSchemesForDefault'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.follower_pressure_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.follower_pressure_bc.FollowerPressureBC(type='FOLLOWER_PRESSURE', name=None, pressure=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'pressure': 'pressure', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this FollowerPressureBC. # noqa: E501
- Returns
The name of this FollowerPressureBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'pressure': 'DimensionalFunctionPressure', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property pressure¶
Gets the pressure of this FollowerPressureBC. # noqa: E501
- Returns
The pressure of this FollowerPressureBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this FollowerPressureBC. # noqa: E501
- Returns
The topological_reference of this FollowerPressureBC. # noqa: E501
- Return type
- property type¶
Gets the type of this FollowerPressureBC. # noqa: E501
In contrast to ordinary pressure, the <b>follower pressure</b> boundary condition is applied normal to the surface of all face elements in the <b>deformed state</b>. This is a nonlinear boundary condition as the update of the geometry is required. In a linear analysis it becomes a simple <b>pressure</b> boundary condition.<br /><br />The following conditions are taken into account: <br /><ul><li>The current deformed state of the surface.</li><li>Any changes in the direction of the normals of assigned entities.</li><li>Changes in the surface area of the assigned faces.</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/follower-pressure/’ target=’_blank’>Learn more</a>. Schema name: FollowerPressureBC # noqa: E501
- Returns
The type of this FollowerPressureBC. # noqa: E501
- Return type
str
simscale_sdk.models.force_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.force_field_selection.ForceFieldSelection(type='FORCE', force_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'force_type': 'forceType', 'type': 'type'}¶
- property force_type¶
Gets the force_type of this ForceFieldSelection. # noqa: E501
- Returns
The force_type of this ForceFieldSelection. # noqa: E501
- Return type
OneOfForceFieldSelectionForceType
- openapi_types = {'force_type': 'OneOfForceFieldSelectionForceType', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ForceFieldSelection. # noqa: E501
Schema name: ForceFieldSelection # noqa: E501
- Returns
The type of this ForceFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.force_load_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.force_load_bc.ForceLoadBC(type='FORCE_LOAD', name=None, force=None, scaling=None, phase_angle=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'force': 'force', 'name': 'name', 'phase_angle': 'phaseAngle', 'scaling': 'scaling', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property force¶
Gets the force of this ForceLoadBC. # noqa: E501
- Returns
The force of this ForceLoadBC. # noqa: E501
- Return type
- property name¶
Gets the name of this ForceLoadBC. # noqa: E501
- Returns
The name of this ForceLoadBC. # noqa: E501
- Return type
str
- openapi_types = {'force': 'DimensionalVectorFunctionForce', 'name': 'str', 'phase_angle': 'DimensionalAngle', 'scaling': 'DimensionalFunctionDimensionless', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this ForceLoadBC. # noqa: E501
- Returns
The phase_angle of this ForceLoadBC. # noqa: E501
- Return type
- property scaling¶
Gets the scaling of this ForceLoadBC. # noqa: E501
- Returns
The scaling of this ForceLoadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this ForceLoadBC. # noqa: E501
- Returns
The topological_reference of this ForceLoadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this ForceLoadBC. # noqa: E501
<p>This is a <b>force</b> boundary condition representing a <b>distributed force on the selection</b>. The total force is defined in the global coordinate system and each element of the assignment is loaded with a surface traction depending on the area of the element.<br /><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/force/’ target=’_blank’>Learn more</a>.</p> Schema name: ForceLoadBC # noqa: E501
- Returns
The type of this ForceLoadBC. # noqa: E501
- Return type
str
simscale_sdk.models.force_moment_coefficients_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.force_moment_coefficients_result_control.ForceMomentCoefficientsResultControl(type='FORCE_AND_MOMENT_COEFFICIENTS', name=None, center_of_rotation=None, lift_direction=None, drag_direction=None, pitch_axis=None, freestream_velocity_magnitude=None, reference_length=None, reference_area_value=None, write_control=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center_of_rotation': 'centerOfRotation', 'drag_direction': 'dragDirection', 'freestream_velocity_magnitude': 'freestreamVelocityMagnitude', 'lift_direction': 'liftDirection', 'name': 'name', 'pitch_axis': 'pitchAxis', 'reference_area_value': 'referenceAreaValue', 'reference_length': 'referenceLength', 'topological_reference': 'topologicalReference', 'type': 'type', 'write_control': 'writeControl'}¶
- property center_of_rotation¶
Gets the center_of_rotation of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The center_of_rotation of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property drag_direction¶
Gets the drag_direction of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The drag_direction of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property freestream_velocity_magnitude¶
Gets the freestream_velocity_magnitude of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The freestream_velocity_magnitude of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property lift_direction¶
Gets the lift_direction of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The lift_direction of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property name¶
Gets the name of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The name of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
str
- openapi_types = {'center_of_rotation': 'DimensionalVectorLength', 'drag_direction': 'DimensionalVectorLength', 'freestream_velocity_magnitude': 'DimensionalSpeed', 'lift_direction': 'DimensionalVectorLength', 'name': 'str', 'pitch_axis': 'DimensionalVectorLength', 'reference_area_value': 'DimensionalArea', 'reference_length': 'DimensionalLength', 'topological_reference': 'TopologicalReference', 'type': 'str', 'write_control': 'OneOfForceMomentCoefficientsResultControlWriteControl'}¶
- property pitch_axis¶
Gets the pitch_axis of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The pitch_axis of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property reference_area_value¶
Gets the reference_area_value of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The reference_area_value of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property reference_length¶
Gets the reference_length of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The reference_length of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The topological_reference of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this ForceMomentCoefficientsResultControl. # noqa: E501
Schema name: ForceMomentCoefficientsResultControl # noqa: E501
- Returns
The type of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this ForceMomentCoefficientsResultControl. # noqa: E501
- Returns
The write_control of this ForceMomentCoefficientsResultControl. # noqa: E501
- Return type
OneOfForceMomentCoefficientsResultControlWriteControl
simscale_sdk.models.force_preload module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.force_preload.ForcePreload(type='FORCE', force=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'force': 'force', 'type': 'type'}¶
- property force¶
Gets the force of this ForcePreload. # noqa: E501
- Returns
The force of this ForcePreload. # noqa: E501
- Return type
- openapi_types = {'force': 'DimensionalForce', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ForcePreload. # noqa: E501
Schema name: ForcePreload # noqa: E501
- Returns
The type of this ForcePreload. # noqa: E501
- Return type
str
simscale_sdk.models.force_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.force_result_control_item.ForceResultControlItem(type='FORCE', name=None, force_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'force_type': 'forceType', 'name': 'name', 'type': 'type'}¶
- property force_type¶
Gets the force_type of this ForceResultControlItem. # noqa: E501
- Returns
The force_type of this ForceResultControlItem. # noqa: E501
- Return type
OneOfForceResultControlItemForceType
- property name¶
Gets the name of this ForceResultControlItem. # noqa: E501
- Returns
The name of this ForceResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'force_type': 'OneOfForceResultControlItemForceType', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ForceResultControlItem. # noqa: E501
Schema name: ForceResultControlItem # noqa: E501
- Returns
The type of this ForceResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.forces_moments_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.forces_moments_result_control.ForcesMomentsResultControl(type='FORCES_AND_MOMENTS', name=None, center_of_rotation=None, write_control=None, fraction_from_end=None, export_statistics=None, group_assignments=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center_of_rotation': 'centerOfRotation', 'export_statistics': 'exportStatistics', 'fraction_from_end': 'fractionFromEnd', 'group_assignments': 'groupAssignments', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type', 'write_control': 'writeControl'}¶
- property center_of_rotation¶
Gets the center_of_rotation of this ForcesMomentsResultControl. # noqa: E501
- Returns
The center_of_rotation of this ForcesMomentsResultControl. # noqa: E501
- Return type
- property export_statistics¶
Gets the export_statistics of this ForcesMomentsResultControl. # noqa: E501
<p>When this switch is activated, statistical data for the selected forces and moments will be exported:</p><ul><li>Minimum (<strong>MIN</strong>)</li><li>Maximum (<strong>MAX</strong>)</li><li>Absolute minimum (<strong>MIN (Abs)</strong>)</li><li>Absolute maximum (<strong>MAX (Abs)</strong>)</li><li>Average (<strong>AVG</strong>)</li><li>Standard deviation (<strong>STDDEV</strong>)</li><li>Root mean square (<strong>RMS (fluctuation)</strong>)</li></ul> # noqa: E501
- Returns
The export_statistics of this ForcesMomentsResultControl. # noqa: E501
- Return type
bool
- property fraction_from_end¶
Gets the fraction_from_end of this ForcesMomentsResultControl. # noqa: E501
It defines the point in simulation where the result output data extraction starts. For instance, <i>Fraction from end</i> of 1 (100%) extracts all data from the beginning of the simulation while default 0.2 extracts 20% data from the end of the simulation. # noqa: E501
- Returns
The fraction_from_end of this ForcesMomentsResultControl. # noqa: E501
- Return type
float
- property group_assignments¶
Gets the group_assignments of this ForcesMomentsResultControl. # noqa: E501
When this switch is activated, forces and moments will be calculated cumulatively on all assignments. When deactivated, they will be calculated individually for each assignment. # noqa: E501
- Returns
The group_assignments of this ForcesMomentsResultControl. # noqa: E501
- Return type
bool
- property name¶
Gets the name of this ForcesMomentsResultControl. # noqa: E501
- Returns
The name of this ForcesMomentsResultControl. # noqa: E501
- Return type
str
- openapi_types = {'center_of_rotation': 'DimensionalVectorLength', 'export_statistics': 'bool', 'fraction_from_end': 'float', 'group_assignments': 'bool', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str', 'write_control': 'OneOfForcesMomentsResultControlWriteControl'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this ForcesMomentsResultControl. # noqa: E501
- Returns
The topological_reference of this ForcesMomentsResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this ForcesMomentsResultControl. # noqa: E501
Schema name: ForcesMomentsResultControl # noqa: E501
- Returns
The type of this ForcesMomentsResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this ForcesMomentsResultControl. # noqa: E501
- Returns
The write_control of this ForcesMomentsResultControl. # noqa: E501
- Return type
OneOfForcesMomentsResultControlWriteControl
simscale_sdk.models.forty_five_view_predefined_camera_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.forty_five_view_predefined_camera_settings.FortyFiveViewPredefinedCameraSettings(setting_type='FORTY_FIVE_FORTY_FIVE_VIEW', projection_type=None, direction_specifier=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'direction_specifier': 'directionSpecifier', 'projection_type': 'projectionType', 'setting_type': 'settingType'}¶
- property direction_specifier¶
Gets the direction_specifier of this FortyFiveViewPredefinedCameraSettings. # noqa: E501
- Returns
The direction_specifier of this FortyFiveViewPredefinedCameraSettings. # noqa: E501
- Return type
str
- openapi_types = {'direction_specifier': 'str', 'projection_type': 'ProjectionType', 'setting_type': 'str'}¶
- property projection_type¶
Gets the projection_type of this FortyFiveViewPredefinedCameraSettings. # noqa: E501
- Returns
The projection_type of this FortyFiveViewPredefinedCameraSettings. # noqa: E501
- Return type
- property setting_type¶
Gets the setting_type of this FortyFiveViewPredefinedCameraSettings. # noqa: E501
- Returns
The setting_type of this FortyFiveViewPredefinedCameraSettings. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.fourth_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fourth_gradient_scheme.FourthGradientScheme(type='FOURTH', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FourthGradientScheme. # noqa: E501
Schema name: FourthGradientScheme # noqa: E501
- Returns
The type of this FourthGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.fractional_height1 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fractional_height1.FractionalHeight1(type='FRACTIONAL_HEIGHT_1', first_layer_size=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'first_layer_size': 'firstLayerSize', 'type': 'type'}¶
- property first_layer_size¶
Gets the first_layer_size of this FractionalHeight1. # noqa: E501
- Returns
The first_layer_size of this FractionalHeight1. # noqa: E501
- Return type
- openapi_types = {'first_layer_size': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FractionalHeight1. # noqa: E501
Schema name: FractionalHeight1 # noqa: E501
- Returns
The type of this FractionalHeight1. # noqa: E501
- Return type
str
simscale_sdk.models.fractional_height2 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.fractional_height2.FractionalHeight2(type='FRACTIONAL_HEIGHT_2', growth_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'growth_rate': 'growthRate', 'type': 'type'}¶
- property growth_rate¶
Gets the growth_rate of this FractionalHeight2. # noqa: E501
The <i>Growth rate</i> defines the thickness ratio between adjacent boundary layer cells. It needs to be always greater than 1 such that the layer thickness increases towards the interior of the mesh. For the same number of layers and overall thickness the larger the growth rate is inversely proportional to the first cell thickness. <img src=”/spec/resources/help/imgs/simmetrix-layer-growth-rate.png” class=”helpPopupImage”/>Example of each cell being 1.5 times thicker than its adjacent. # noqa: E501
- Returns
The growth_rate of this FractionalHeight2. # noqa: E501
- Return type
float
- openapi_types = {'growth_rate': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FractionalHeight2. # noqa: E501
Schema name: FractionalHeight2 # noqa: E501
- Returns
The type of this FractionalHeight2. # noqa: E501
- Return type
str
simscale_sdk.models.freestream_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.freestream_pbc.FreestreamPBC(type='FREESTREAM', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FreestreamPBC. # noqa: E501
Schema name: FreestreamPBC # noqa: E501
- Returns
The type of this FreestreamPBC. # noqa: E501
- Return type
str
simscale_sdk.models.freestream_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.freestream_vbc.FreestreamVBC(type='FREESTREAM', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalVectorSpeed'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FreestreamVBC. # noqa: E501
Schema name: FreestreamVBC # noqa: E501
- Returns
The type of this FreestreamVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this FreestreamVBC. # noqa: E501
- Returns
The value of this FreestreamVBC. # noqa: E501
- Return type
simscale_sdk.models.frequency_analysis module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.frequency_analysis.FrequencyAnalysis(type='FREQUENCY_ANALYSIS', connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'element_technology': 'elementTechnology', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'mesh_order': 'meshOrder', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this FrequencyAnalysis. # noqa: E501
- Returns
The boundary_conditions of this FrequencyAnalysis. # noqa: E501
- Return type
list[OneOfFrequencyAnalysisBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this FrequencyAnalysis. # noqa: E501
- Returns
The connection_groups of this FrequencyAnalysis. # noqa: E501
- Return type
list[Contact]
- property element_technology¶
Gets the element_technology of this FrequencyAnalysis. # noqa: E501
- Returns
The element_technology of this FrequencyAnalysis. # noqa: E501
- Return type
- property initial_conditions¶
Gets the initial_conditions of this FrequencyAnalysis. # noqa: E501
- Returns
The initial_conditions of this FrequencyAnalysis. # noqa: E501
- Return type
- property materials¶
Gets the materials of this FrequencyAnalysis. # noqa: E501
- Returns
The materials of this FrequencyAnalysis. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this FrequencyAnalysis. # noqa: E501
- Returns
The mesh_order of this FrequencyAnalysis. # noqa: E501
- Return type
str
- property model¶
Gets the model of this FrequencyAnalysis. # noqa: E501
- Returns
The model of this FrequencyAnalysis. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this FrequencyAnalysis. # noqa: E501
- Returns
The numerics of this FrequencyAnalysis. # noqa: E501
- Return type
- openapi_types = {'boundary_conditions': 'list[OneOfFrequencyAnalysisBoundaryConditions]', 'connection_groups': 'list[Contact]', 'element_technology': 'SolidElementTechnology', 'initial_conditions': 'SolidInitialConditions', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'model': 'SolidModel', 'numerics': 'SolidNumerics', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this FrequencyAnalysis. # noqa: E501
- Returns
The result_control of this FrequencyAnalysis. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this FrequencyAnalysis. # noqa: E501
- Returns
The simulation_control of this FrequencyAnalysis. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrequencyAnalysis. # noqa: E501
Schema name: FrequencyAnalysis # noqa: E501
- Returns
The type of this FrequencyAnalysis. # noqa: E501
- Return type
str
simscale_sdk.models.frequency_list module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.frequency_list.FrequencyList(type='LIST_V20', start_frequency=None, end_frequency=None, frequency_stepping=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'end_frequency': 'endFrequency', 'frequency_stepping': 'frequencyStepping', 'start_frequency': 'startFrequency', 'type': 'type'}¶
- property end_frequency¶
Gets the end_frequency of this FrequencyList. # noqa: E501
- Returns
The end_frequency of this FrequencyList. # noqa: E501
- Return type
- property frequency_stepping¶
Gets the frequency_stepping of this FrequencyList. # noqa: E501
- Returns
The frequency_stepping of this FrequencyList. # noqa: E501
- Return type
- openapi_types = {'end_frequency': 'DimensionalFrequency', 'frequency_stepping': 'RestrictedDimensionalFunctionFrequency', 'start_frequency': 'DimensionalFrequency', 'type': 'str'}¶
- property start_frequency¶
Gets the start_frequency of this FrequencyList. # noqa: E501
- Returns
The start_frequency of this FrequencyList. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrequencyList. # noqa: E501
<p>Set the frequencies for the harmonic excitation. Setting it to <b>single frequency</b> will only compute harmonic excitation on that frequency. To have harmonic excitations on multiple frequencies, please choose <b>frequency list</b>. </p> Schema name: FrequencyList # noqa: E501
- Returns
The type of this FrequencyList. # noqa: E501
- Return type
str
simscale_sdk.models.frequency_range module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.frequency_range.FrequencyRange(type='RANGE', start_frequency=None, end_frequency=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'end_frequency': 'endFrequency', 'start_frequency': 'startFrequency', 'type': 'type'}¶
- property end_frequency¶
Gets the end_frequency of this FrequencyRange. # noqa: E501
- Returns
The end_frequency of this FrequencyRange. # noqa: E501
- Return type
- openapi_types = {'end_frequency': 'DimensionalFrequency', 'start_frequency': 'DimensionalFrequency', 'type': 'str'}¶
- property start_frequency¶
Gets the start_frequency of this FrequencyRange. # noqa: E501
- Returns
The start_frequency of this FrequencyRange. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrequencyRange. # noqa: E501
<p>Select how you want to control natural frequencies to be computed:</p> <li><i>First modes</i>: The first <i>Number of modes</i> will be searched and computed, in the order of low to high frequency.</li><li><i>Frequency range</i>: All the modes within the range of frequencies will be searched and computed. The frequency range is specified by a <i>Start frequency</i> and an <i>End frequency</i>.</li> Schema name: FrequencyRange # noqa: E501
- Returns
The type of this FrequencyRange. # noqa: E501
- Return type
str
simscale_sdk.models.friction_augmented_lagrange_coef module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.friction_augmented_lagrange_coef.FrictionAugmentedLagrangeCoef(type='FRICTION_AUGMENTATION_COEF', friction_augmentation_coefficient=None, coulomb_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'coulomb_coefficient': 'coulombCoefficient', 'friction_augmentation_coefficient': 'frictionAugmentationCoefficient', 'type': 'type'}¶
- property coulomb_coefficient¶
Gets the coulomb_coefficient of this FrictionAugmentedLagrangeCoef. # noqa: E501
- Returns
The coulomb_coefficient of this FrictionAugmentedLagrangeCoef. # noqa: E501
- Return type
float
- property friction_augmentation_coefficient¶
Gets the friction_augmentation_coefficient of this FrictionAugmentedLagrangeCoef. # noqa: E501
- Returns
The friction_augmentation_coefficient of this FrictionAugmentedLagrangeCoef. # noqa: E501
- Return type
- openapi_types = {'coulomb_coefficient': 'float', 'friction_augmentation_coefficient': 'DimensionalFrictionAugmentation', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrictionAugmentedLagrangeCoef. # noqa: E501
Schema name: FrictionAugmentedLagrangeCoef # noqa: E501
- Returns
The type of this FrictionAugmentedLagrangeCoef. # noqa: E501
- Return type
str
simscale_sdk.models.friction_contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.friction_contact.FrictionContact(type='FRICTION_CONTACT', name=None, contact_solution_method=None, friction_coefficient=None, fictitious_clearance=None, master_topological_reference=None, slave_topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_solution_method': 'contactSolutionMethod', 'fictitious_clearance': 'fictitiousClearance', 'friction_coefficient': 'frictionCoefficient', 'master_topological_reference': 'masterTopologicalReference', 'name': 'name', 'slave_topological_reference': 'slaveTopologicalReference', 'type': 'type'}¶
- property contact_solution_method¶
Gets the contact_solution_method of this FrictionContact. # noqa: E501
- Returns
The contact_solution_method of this FrictionContact. # noqa: E501
- Return type
OneOfFrictionContactContactSolutionMethod
- property fictitious_clearance¶
Gets the fictitious_clearance of this FrictionContact. # noqa: E501
- Returns
The fictitious_clearance of this FrictionContact. # noqa: E501
- Return type
OneOfFrictionContactFictitiousClearance
- property friction_coefficient¶
Gets the friction_coefficient of this FrictionContact. # noqa: E501
- Returns
The friction_coefficient of this FrictionContact. # noqa: E501
- Return type
OneOfFrictionContactFrictionCoefficient
- property master_topological_reference¶
Gets the master_topological_reference of this FrictionContact. # noqa: E501
- Returns
The master_topological_reference of this FrictionContact. # noqa: E501
- Return type
- property name¶
Gets the name of this FrictionContact. # noqa: E501
- Returns
The name of this FrictionContact. # noqa: E501
- Return type
str
- openapi_types = {'contact_solution_method': 'OneOfFrictionContactContactSolutionMethod', 'fictitious_clearance': 'OneOfFrictionContactFictitiousClearance', 'friction_coefficient': 'OneOfFrictionContactFrictionCoefficient', 'master_topological_reference': 'TopologicalReference', 'name': 'str', 'slave_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property slave_topological_reference¶
Gets the slave_topological_reference of this FrictionContact. # noqa: E501
- Returns
The slave_topological_reference of this FrictionContact. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrictionContact. # noqa: E501
Schema name: FrictionContact # noqa: E501
- Returns
The type of this FrictionContact. # noqa: E501
- Return type
str
simscale_sdk.models.friction_penalty_coef module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.friction_penalty_coef.FrictionPenaltyCoef(type='FRICTION_PENALTY_COEF', friction_penalty_coefficient=None, coulomb_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'coulomb_coefficient': 'coulombCoefficient', 'friction_penalty_coefficient': 'frictionPenaltyCoefficient', 'type': 'type'}¶
- property coulomb_coefficient¶
Gets the coulomb_coefficient of this FrictionPenaltyCoef. # noqa: E501
- Returns
The coulomb_coefficient of this FrictionPenaltyCoef. # noqa: E501
- Return type
float
- property friction_penalty_coefficient¶
Gets the friction_penalty_coefficient of this FrictionPenaltyCoef. # noqa: E501
- Returns
The friction_penalty_coefficient of this FrictionPenaltyCoef. # noqa: E501
- Return type
float
- openapi_types = {'coulomb_coefficient': 'float', 'friction_penalty_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrictionPenaltyCoef. # noqa: E501
Schema name: FrictionPenaltyCoef # noqa: E501
- Returns
The type of this FrictionPenaltyCoef. # noqa: E501
- Return type
str
simscale_sdk.models.friction_velocity_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.friction_velocity_result_type.FrictionVelocityResultType(type='FRICTION_VELOCITY_U_TAU', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrictionVelocityResultType. # noqa: E501
Schema name: FrictionVelocityResultType # noqa: E501
- Returns
The type of this FrictionVelocityResultType. # noqa: E501
- Return type
str
simscale_sdk.models.frictionless_contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.frictionless_contact.FrictionlessContact(type='FRICTIONLESS_CONTACT', name=None, contact_solution_method=None, fictitious_clearance=None, master_topological_reference=None, slave_topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_solution_method': 'contactSolutionMethod', 'fictitious_clearance': 'fictitiousClearance', 'master_topological_reference': 'masterTopologicalReference', 'name': 'name', 'slave_topological_reference': 'slaveTopologicalReference', 'type': 'type'}¶
- property contact_solution_method¶
Gets the contact_solution_method of this FrictionlessContact. # noqa: E501
- Returns
The contact_solution_method of this FrictionlessContact. # noqa: E501
- Return type
OneOfFrictionlessContactContactSolutionMethod
- property fictitious_clearance¶
Gets the fictitious_clearance of this FrictionlessContact. # noqa: E501
- Returns
The fictitious_clearance of this FrictionlessContact. # noqa: E501
- Return type
OneOfFrictionlessContactFictitiousClearance
- property master_topological_reference¶
Gets the master_topological_reference of this FrictionlessContact. # noqa: E501
- Returns
The master_topological_reference of this FrictionlessContact. # noqa: E501
- Return type
- property name¶
Gets the name of this FrictionlessContact. # noqa: E501
- Returns
The name of this FrictionlessContact. # noqa: E501
- Return type
str
- openapi_types = {'contact_solution_method': 'OneOfFrictionlessContactContactSolutionMethod', 'fictitious_clearance': 'OneOfFrictionlessContactFictitiousClearance', 'master_topological_reference': 'TopologicalReference', 'name': 'str', 'slave_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property slave_topological_reference¶
Gets the slave_topological_reference of this FrictionlessContact. # noqa: E501
- Returns
The slave_topological_reference of this FrictionlessContact. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FrictionlessContact. # noqa: E501
Schema name: FrictionlessContact # noqa: E501
- Returns
The type of this FrictionlessContact. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_dvbc.FullResolutionDVBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionDVBC. # noqa: E501
Schema name: FullResolutionDVBC # noqa: E501
- Returns
The type of this FullResolutionDVBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_ebc.FullResolutionEBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionEBC. # noqa: E501
Schema name: FullResolutionEBC # noqa: E501
- Returns
The type of this FullResolutionEBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_evbc.FullResolutionEVBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionEVBC. # noqa: E501
Schema name: FullResolutionEVBC # noqa: E501
- Returns
The type of this FullResolutionEVBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_evcbc.FullResolutionEVCBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionEVCBC. # noqa: E501
Schema name: FullResolutionEVCBC # noqa: E501
- Returns
The type of this FullResolutionEVCBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_nbc.FullResolutionNBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionNBC. # noqa: E501
Schema name: FullResolutionNBC # noqa: E501
- Returns
The type of this FullResolutionNBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_obc.FullResolutionOBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionOBC. # noqa: E501
Schema name: FullResolutionOBC # noqa: E501
- Returns
The type of this FullResolutionOBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_tdbc.FullResolutionTDBC(type='FULL_RESOLUTION', prandtl_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'prandtl_number': 'prandtlNumber', 'type': 'type'}¶
- openapi_types = {'prandtl_number': 'float', 'type': 'str'}¶
- property prandtl_number¶
Gets the prandtl_number of this FullResolutionTDBC. # noqa: E501
- Returns
The prandtl_number of this FullResolutionTDBC. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionTDBC. # noqa: E501
Schema name: FullResolutionTDBC # noqa: E501
- Returns
The type of this FullResolutionTDBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_tdcbc.FullResolutionTDCBC(type='FULL_RESOLUTION', prandtl_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'prandtl_number': 'prandtlNumber', 'type': 'type'}¶
- openapi_types = {'prandtl_number': 'float', 'type': 'str'}¶
- property prandtl_number¶
Gets the prandtl_number of this FullResolutionTDCBC. # noqa: E501
- Returns
The prandtl_number of this FullResolutionTDCBC. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionTDCBC. # noqa: E501
Schema name: FullResolutionTDCBC # noqa: E501
- Returns
The type of this FullResolutionTDCBC. # noqa: E501
- Return type
str
simscale_sdk.models.full_resolution_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.full_resolution_tkebc.FullResolutionTKEBC(type='FULL_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this FullResolutionTKEBC. # noqa: E501
Schema name: FullResolutionTKEBC # noqa: E501
- Returns
The type of this FullResolutionTKEBC. # noqa: E501
- Return type
str
simscale_sdk.models.function_parameter module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.function_parameter.FunctionParameter(parameter=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'parameter': 'parameter', 'unit': 'unit'}¶
- openapi_types = {'parameter': 'str', 'unit': 'str'}¶
- property parameter¶
Gets the parameter of this FunctionParameter. # noqa: E501
- Returns
The parameter of this FunctionParameter. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this FunctionParameter. # noqa: E501
- Returns
The unit of this FunctionParameter. # noqa: E501
- Return type
str
simscale_sdk.models.gamg_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gamg_solver.GAMGSolver(type='GAMG', absolute_tolerance=None, relative_tolerance=None, smoother=None, num_pre_sweeps=None, num_post_sweeps=None, cache_agglomeration_on=None, num_cells_coarsest_level=None, num_merge_levels=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property absolute_tolerance¶
Gets the absolute_tolerance of this GAMGSolver. # noqa: E501
<p>Define the absolute tolerance for the residual. The convergence process will be stopped as soon as the residual falls below the absolute tolerance.</p> # noqa: E501
- Returns
The absolute_tolerance of this GAMGSolver. # noqa: E501
- Return type
float
- attribute_map = {'absolute_tolerance': 'absoluteTolerance', 'cache_agglomeration_on': 'cacheAgglomerationOn', 'num_cells_coarsest_level': 'numCellsCoarsestLevel', 'num_merge_levels': 'numMergeLevels', 'num_post_sweeps': 'numPostSweeps', 'num_pre_sweeps': 'numPreSweeps', 'relative_tolerance': 'relativeTolerance', 'smoother': 'smoother', 'type': 'type'}¶
- property cache_agglomeration_on¶
Gets the cache_agglomeration_on of this GAMGSolver. # noqa: E501
- Returns
The cache_agglomeration_on of this GAMGSolver. # noqa: E501
- Return type
bool
- property num_cells_coarsest_level¶
Gets the num_cells_coarsest_level of this GAMGSolver. # noqa: E501
- Returns
The num_cells_coarsest_level of this GAMGSolver. # noqa: E501
- Return type
int
- property num_merge_levels¶
Gets the num_merge_levels of this GAMGSolver. # noqa: E501
- Returns
The num_merge_levels of this GAMGSolver. # noqa: E501
- Return type
int
- property num_post_sweeps¶
Gets the num_post_sweeps of this GAMGSolver. # noqa: E501
- Returns
The num_post_sweeps of this GAMGSolver. # noqa: E501
- Return type
int
- property num_pre_sweeps¶
Gets the num_pre_sweeps of this GAMGSolver. # noqa: E501
- Returns
The num_pre_sweeps of this GAMGSolver. # noqa: E501
- Return type
int
- openapi_types = {'absolute_tolerance': 'float', 'cache_agglomeration_on': 'bool', 'num_cells_coarsest_level': 'int', 'num_merge_levels': 'int', 'num_post_sweeps': 'int', 'num_pre_sweeps': 'int', 'relative_tolerance': 'float', 'smoother': 'str', 'type': 'str'}¶
- property relative_tolerance¶
Gets the relative_tolerance of this GAMGSolver. # noqa: E501
<p>Choose the relative tolerance for the residual. The convergence process will be stopped as soon as the ratio of current to initial residual falls below the relative tolerance.</p> # noqa: E501
- Returns
The relative_tolerance of this GAMGSolver. # noqa: E501
- Return type
float
- property smoother¶
Gets the smoother of this GAMGSolver. # noqa: E501
<p>Choose a smoother for your solver.</p> # noqa: E501
- Returns
The smoother of this GAMGSolver. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GAMGSolver. # noqa: E501
Schema name: GAMGSolver # noqa: E501
- Returns
The type of this GAMGSolver. # noqa: E501
- Return type
str
simscale_sdk.models.garofalo_creep_formulation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.garofalo_creep_formulation.GarofaloCreepFormulation(type='GAROFALO', a=None, n=None, s=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property a¶
Gets the a of this GarofaloCreepFormulation. # noqa: E501
- Returns
The a of this GarofaloCreepFormulation. # noqa: E501
- Return type
- attribute_map = {'a': 'a', 'n': 'n', 's': 's', 'type': 'type'}¶
- property n¶
Gets the n of this GarofaloCreepFormulation. # noqa: E501
<p>Define the parameter <b>σ<sub>0</sub></b> of the Garofalo creep formulation: <ul><b>ε̇ = ε<sub>0</sub>* &sinh(σ/(&sigma<sub>0</sub>))<sup>n</sup></b></ul></p> # noqa: E501
- Returns
The n of this GarofaloCreepFormulation. # noqa: E501
- Return type
float
- openapi_types = {'a': 'DimensionalStrainRate', 'n': 'float', 's': 'float', 'type': 'str'}¶
- property s¶
Gets the s of this GarofaloCreepFormulation. # noqa: E501
<p>Define the parameter <b>ε<sub>0</sub></b> of the Garofalo creep formulation: <ul><b>ε̇ = ε<sub>0</sub>* &sinh(σ/(&sigma<sub>0</sub>))<sup>n</sup></b></ul></p> # noqa: E501
- Returns
The s of this GarofaloCreepFormulation. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GarofaloCreepFormulation. # noqa: E501
<p>Define the Creep formulation. Two fundamental Creep law types are available: <ul><li><b>Power Law</b></li><b>ε̇ = m*A*σ<sup>n</sup>*t<sup>m-1</sup></b><li><b>Hyperbolic Sine Law</b> </li><b>ε̇= ε<sub>0</sub>* sinh(σ/(σ<sub>0</sub>))<sup>n</sup></b>.</ul> For the Power Law different formulations, like the <b>Norton</b>, <b>Strain Hardening</b> or <b>Time Hardening</b> are available. For the Hyperbolic Sine Law, the <b>Garofalo<b> formulation is available.</p> Schema name: GarofaloCreepFormulation # noqa: E501
- Returns
The type of this GarofaloCreepFormulation. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_interface_compression_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_interface_compression_divergence_scheme.GaussInterfaceCompressionDivergenceScheme(type='GAUSS_INTERFACECOMPRESSION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussInterfaceCompressionDivergenceScheme. # noqa: E501
Schema name: GaussInterfaceCompressionDivergenceScheme # noqa: E501
- Returns
The type of this GaussInterfaceCompressionDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_limited_linear1_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_limited_linear1_divergence_scheme.GaussLimitedLinear1DivergenceScheme(type='GAUSS_LIMITEDLINEAR_1', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLimitedLinear1DivergenceScheme. # noqa: E501
Schema name: GaussLimitedLinear1DivergenceScheme # noqa: E501
- Returns
The type of this GaussLimitedLinear1DivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_limited_linear_v1_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_limited_linear_v1_divergence_scheme.GaussLimitedLinearV1DivergenceScheme(type='GAUSS_LIMITEDLINEARV_1', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLimitedLinearV1DivergenceScheme. # noqa: E501
Schema name: GaussLimitedLinearV1DivergenceScheme # noqa: E501
- Returns
The type of this GaussLimitedLinearV1DivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_corrected_laplacian_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_corrected_laplacian_scheme.GaussLinearCorrectedLaplacianScheme(type='GAUSS_LINEAR_CORRECTED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearCorrectedLaplacianScheme. # noqa: E501
Schema name: GaussLinearCorrectedLaplacianScheme # noqa: E501
- Returns
The type of this GaussLinearCorrectedLaplacianScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_divergence_scheme.GaussLinearDivergenceScheme(type='GAUSS_LINEAR', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearDivergenceScheme. # noqa: E501
Schema name: GaussLinearDivergenceScheme # noqa: E501
- Returns
The type of this GaussLinearDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_gradient_scheme.GaussLinearGradientScheme(type='GAUSS_LINEAR', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearGradientScheme. # noqa: E501
Schema name: GaussLinearGradientScheme # noqa: E501
- Returns
The type of this GaussLinearGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_limited_corrected_laplacian_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_limited_corrected_laplacian_scheme.GaussLinearLimitedCorrectedLaplacianScheme(type='GAUSS_LINEAR_LIMITED_CORRECTED', limiter_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'limiter_coefficient': 'limiterCoefficient', 'type': 'type'}¶
- property limiter_coefficient¶
Gets the limiter_coefficient of this GaussLinearLimitedCorrectedLaplacianScheme. # noqa: E501
This property defines a limiter coefficient for the scheme. 1 ensures boundedness while 0 applies no limiting. # noqa: E501
- Returns
The limiter_coefficient of this GaussLinearLimitedCorrectedLaplacianScheme. # noqa: E501
- Return type
float
- openapi_types = {'limiter_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearLimitedCorrectedLaplacianScheme. # noqa: E501
Schema name: GaussLinearLimitedCorrectedLaplacianScheme # noqa: E501
- Returns
The type of this GaussLinearLimitedCorrectedLaplacianScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_uncorrected_laplacian_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_uncorrected_laplacian_scheme.GaussLinearUncorrectedLaplacianScheme(type='GAUSS_LINEAR_UNCORRECTED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearUncorrectedLaplacianScheme. # noqa: E501
Schema name: GaussLinearUncorrectedLaplacianScheme # noqa: E501
- Returns
The type of this GaussLinearUncorrectedLaplacianScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_upwind_limited_grad_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_upwind_limited_grad_divergence_scheme.GaussLinearUpwindLimitedGradDivergenceScheme(type='GAUSS_LINEARUPWIND_LIMITEDGRAD', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearUpwindLimitedGradDivergenceScheme. # noqa: E501
Schema name: GaussLinearUpwindLimitedGradDivergenceScheme # noqa: E501
- Returns
The type of this GaussLinearUpwindLimitedGradDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_upwind_unlimited_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_upwind_unlimited_divergence_scheme.GaussLinearUpwindUnlimitedDivergenceScheme(type='GAUSS_LINEARUPWIND_UNLIMITED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearUpwindUnlimitedDivergenceScheme. # noqa: E501
Schema name: GaussLinearUpwindUnlimitedDivergenceScheme # noqa: E501
- Returns
The type of this GaussLinearUpwindUnlimitedDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_upwind_v_grad_u_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_upwind_v_grad_u_divergence_scheme.GaussLinearUpwindVGradUDivergenceScheme(type='GAUSS_LINEARUPWINDV_GRAD_U_', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearUpwindVGradUDivergenceScheme. # noqa: E501
Schema name: GaussLinearUpwindVGradUDivergenceScheme # noqa: E501
- Returns
The type of this GaussLinearUpwindVGradUDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_linear_upwind_v_unlimited_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_linear_upwind_v_unlimited_divergence_scheme.GaussLinearUpwindVUnlimitedDivergenceScheme(type='GAUSS_LINEARUPWINDV_UNLIMITED', limiter_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'limiter_coefficient': 'limiterCoefficient', 'type': 'type'}¶
- property limiter_coefficient¶
Gets the limiter_coefficient of this GaussLinearUpwindVUnlimitedDivergenceScheme. # noqa: E501
This property defines a limiter coefficient for the scheme. 1 ensures boundedness while 0 applies no limiting. # noqa: E501
- Returns
The limiter_coefficient of this GaussLinearUpwindVUnlimitedDivergenceScheme. # noqa: E501
- Return type
float
- openapi_types = {'limiter_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussLinearUpwindVUnlimitedDivergenceScheme. # noqa: E501
Schema name: GaussLinearUpwindVUnlimitedDivergenceScheme # noqa: E501
- Returns
The type of this GaussLinearUpwindVUnlimitedDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_upwind_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_upwind_divergence_scheme.GaussUpwindDivergenceScheme(type='GAUSS_UPWIND', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussUpwindDivergenceScheme. # noqa: E501
Schema name: GaussUpwindDivergenceScheme # noqa: E501
- Returns
The type of this GaussUpwindDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gauss_vanleer_divergence_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gauss_vanleer_divergence_scheme.GaussVanleerDivergenceScheme(type='GAUSS_VANLEER', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GaussVanleerDivergenceScheme. # noqa: E501
Schema name: GaussVanleerDivergenceScheme # noqa: E501
- Returns
The type of this GaussVanleerDivergenceScheme. # noqa: E501
- Return type
str
simscale_sdk.models.gcpc_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gcpc_solver.GCPCSolver(type='GCPC', force_symmetric=None, preconditioner=None, max_iterations=None, convergence_threshold=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'convergence_threshold': 'convergenceThreshold', 'force_symmetric': 'forceSymmetric', 'max_iterations': 'maxIterations', 'preconditioner': 'preconditioner', 'type': 'type'}¶
- property convergence_threshold¶
Gets the convergence_threshold of this GCPCSolver. # noqa: E501
Set the threshold value for convergence detection for the relative convergence criteria. # noqa: E501
- Returns
The convergence_threshold of this GCPCSolver. # noqa: E501
- Return type
float
- property force_symmetric¶
Gets the force_symmetric of this GCPCSolver. # noqa: E501
Choose if you want to enforce a symmetric matrix. # noqa: E501
- Returns
The force_symmetric of this GCPCSolver. # noqa: E501
- Return type
bool
- property max_iterations¶
Gets the max_iterations of this GCPCSolver. # noqa: E501
Set the maximum number of iterations for the iterative solver. If set to 0 the algorithm computes the maximum number of iterations as the the number of equations ot the system divided by 2. # noqa: E501
- Returns
The max_iterations of this GCPCSolver. # noqa: E501
- Return type
int
- openapi_types = {'convergence_threshold': 'float', 'force_symmetric': 'bool', 'max_iterations': 'int', 'preconditioner': 'OneOfGCPCSolverPreconditioner', 'type': 'str'}¶
- property preconditioner¶
Gets the preconditioner of this GCPCSolver. # noqa: E501
- Returns
The preconditioner of this GCPCSolver. # noqa: E501
- Return type
OneOfGCPCSolverPreconditioner
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GCPCSolver. # noqa: E501
<p>Choose a linear equation system solver for your calculation:</p><ul><li><p><b>Multfront</b> is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.</p></ul><ul><li><p><b>MUMPS</b> is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.</p></ul><ul><li><p><b>LDLT</b> is a direct solver which uses a Gaussian Algortihm. It is comparatively slow for big problems.</p></ul><ul><li><p><b>PETSC</b> is an iterative solver specially designed to deal with large systems. It scales very effectively in parallel and is the best choice for large problems.</p></ul><ul><li><p><b>GCPC</b> is an iterative solver of the pre-conditioned conjugate gradient type. It scales well in parallel and is also usable for large problems.</p></ul> Schema name: GCPCSolver # noqa: E501
- Returns
The type of this GCPCSolver. # noqa: E501
- Return type
str
simscale_sdk.models.general_darcy_forchheimer_pacefish module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.general_darcy_forchheimer_pacefish.GeneralDarcyForchheimerPacefish(type='GENERAL_POROSITY', name=None, darcy_forchheimer_type=None, permeability=None, friction_form_coefficient=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'darcy_forchheimer_type': 'darcyForchheimerType', 'friction_form_coefficient': 'frictionFormCoefficient', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'permeability': 'permeability', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property darcy_forchheimer_type¶
Gets the darcy_forchheimer_type of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Returns
The darcy_forchheimer_type of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
OneOfGeneralDarcyForchheimerPacefishDarcyForchheimerType
- property friction_form_coefficient¶
Gets the friction_form_coefficient of this GeneralDarcyForchheimerPacefish. # noqa: E501
Friction form coefficient defines the pressure losses due to inertial effects through the porous object. The greater the friction form coefficient, the greater the pressure losses due to inertial effects are. Friction form coefficient of zero means that there are no inertial losses through the porous object. # noqa: E501
- Returns
The friction_form_coefficient of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
float
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Returns
The geometry_primitive_uuids of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Returns
The name of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
str
- openapi_types = {'darcy_forchheimer_type': 'OneOfGeneralDarcyForchheimerPacefishDarcyForchheimerType', 'friction_form_coefficient': 'float', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'permeability': 'DimensionalArea', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property permeability¶
Gets the permeability of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Returns
The permeability of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Returns
The topological_reference of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
- property type¶
Gets the type of this GeneralDarcyForchheimerPacefish. # noqa: E501
Schema name: GeneralDarcyForchheimerPacefish # noqa: E501
- Returns
The type of this GeneralDarcyForchheimerPacefish. # noqa: E501
- Return type
str
simscale_sdk.models.general_hole_shape module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.general_hole_shape.GeneralHoleShape(type='GENERAL', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GeneralHoleShape. # noqa: E501
General formulation that does not depend on the shape of the holes. Valid only for thin plates where thickness to hole ratio is less than 0.015 and Reynolds number is greater than 10000. Schema name: GeneralHoleShape # noqa: E501
- Returns
The type of this GeneralHoleShape. # noqa: E501
- Return type
str
simscale_sdk.models.geographical_location module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geographical_location.GeographicalLocation(latitude=None, longitude=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'latitude': 'latitude', 'longitude': 'longitude'}¶
- property latitude¶
Gets the latitude of this GeographicalLocation. # noqa: E501
- Returns
The latitude of this GeographicalLocation. # noqa: E501
- Return type
- property longitude¶
Gets the longitude of this GeographicalLocation. # noqa: E501
- Returns
The longitude of this GeographicalLocation. # noqa: E501
- Return type
- openapi_types = {'latitude': 'DimensionalAngle', 'longitude': 'DimensionalAngle'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometries module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometries.Geometries(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this Geometries. # noqa: E501
- Returns
The embedded of this Geometries. # noqa: E501
- Return type
list[Geometry]
- property links¶
Gets the links of this Geometries. # noqa: E501
- Returns
The links of this Geometries. # noqa: E501
- Return type
- property meta¶
Gets the meta of this Geometries. # noqa: E501
- Returns
The meta of this Geometries. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[Geometry]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry.Geometry(geometry_id=None, name=None, created_at=None, format=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'format': 'format', 'geometry_id': 'geometryId', 'name': 'name'}¶
- property created_at¶
Gets the created_at of this Geometry. # noqa: E501
The time when the geometry was imported. # noqa: E501
- Returns
The created_at of this Geometry. # noqa: E501
- Return type
datetime
- property format¶
Gets the format of this Geometry. # noqa: E501
The geometry format. # noqa: E501
- Returns
The format of this Geometry. # noqa: E501
- Return type
str
- property geometry_id¶
Gets the geometry_id of this Geometry. # noqa: E501
- Returns
The geometry_id of this Geometry. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Geometry. # noqa: E501
The name of the geometry. # noqa: E501
- Returns
The name of this Geometry. # noqa: E501
- Return type
str
- openapi_types = {'created_at': 'datetime', 'format': 'str', 'geometry_id': 'str', 'name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_import_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_import_request.GeometryImportRequest(name=None, location=None, format=None, input_unit=None, options=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'format': 'format', 'input_unit': 'inputUnit', 'location': 'location', 'name': 'name', 'options': 'options'}¶
- property format¶
Gets the format of this GeometryImportRequest. # noqa: E501
The CAD format. # noqa: E501
- Returns
The format of this GeometryImportRequest. # noqa: E501
- Return type
str
- property input_unit¶
Gets the input_unit of this GeometryImportRequest. # noqa: E501
- Returns
The input_unit of this GeometryImportRequest. # noqa: E501
- Return type
- property location¶
Gets the location of this GeometryImportRequest. # noqa: E501
- Returns
The location of this GeometryImportRequest. # noqa: E501
- Return type
- property name¶
Gets the name of this GeometryImportRequest. # noqa: E501
The name of the imported geometry. # noqa: E501
- Returns
The name of this GeometryImportRequest. # noqa: E501
- Return type
str
- openapi_types = {'format': 'str', 'input_unit': 'GeometryUnit', 'location': 'GeometryImportRequestLocation', 'name': 'str', 'options': 'GeometryImportRequestOptions'}¶
- property options¶
Gets the options of this GeometryImportRequest. # noqa: E501
- Returns
The options of this GeometryImportRequest. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_import_request_location module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_import_request_location.GeometryImportRequestLocation(storage_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'storage_id': 'storageId'}¶
- openapi_types = {'storage_id': 'str'}¶
- property storage_id¶
Gets the storage_id of this GeometryImportRequestLocation. # noqa: E501
The storage ID of the temporary storage location where the CAD file has been uploaded. # noqa: E501
- Returns
The storage_id of this GeometryImportRequestLocation. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_import_request_options module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_import_request_options.GeometryImportRequestOptions(facet_split=False, sewing=False, improve=True, optimize_for_lbm_solver=False, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'facet_split': 'facetSplit', 'improve': 'improve', 'optimize_for_lbm_solver': 'optimizeForLBMSolver', 'sewing': 'sewing'}¶
- property facet_split¶
Gets the facet_split of this GeometryImportRequestOptions. # noqa: E501
_Facet Split_ tries to split the faceted parts of a model. This means it can create new faces from original faces. In this case it’s not possible to use the original faces to make assignments. # noqa: E501
- Returns
The facet_split of this GeometryImportRequestOptions. # noqa: E501
- Return type
bool
- property improve¶
Gets the improve of this GeometryImportRequestOptions. # noqa: E501
This option tries to improve the topology (e.g. edges, vertices) and geometry of the model by adjusting tolerances, simplifying entities, etc. As this option should improve CAD operations and data handling for all downstream applications it is recommended to use it on import. For very complex models it can take a considerable amount of time though, therefore you can also opt-out and reconsider in case you face issues in geometry handling or meshing. # noqa: E501
- Returns
The improve of this GeometryImportRequestOptions. # noqa: E501
- Return type
bool
- openapi_types = {'facet_split': 'bool', 'improve': 'bool', 'optimize_for_lbm_solver': 'bool', 'sewing': 'bool'}¶
- property optimize_for_lbm_solver¶
Gets the optimize_for_lbm_solver of this GeometryImportRequestOptions. # noqa: E501
This option allows you to import a *.stl file that is optimized for the Incompressible LBM and Wind Comfort analysis types. It leaves out complex import steps like sewing and cleanup that are not required by the LBM solver and therefore also allows to import big and complex models fast. # noqa: E501
- Returns
The optimize_for_lbm_solver of this GeometryImportRequestOptions. # noqa: E501
- Return type
bool
- property sewing¶
Gets the sewing of this GeometryImportRequestOptions. # noqa: E501
_Automatic Sewing_ is sewing faces or sheet bodies together. This means that it can create one new face from two (or more) original faces, as well as one solid body from two (or more) original sheet bodies. In this case, if the entities have the same ID, it will be inherited by the newly created entity. However if the original entities do not share the same ID, only one of these will be mapped to the new entity. This might not be desirable if one would like to make assignments on the original entities and not on the new (sewn) entities. # noqa: E501
- Returns
The sewing of this GeometryImportRequestOptions. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_import_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_import_response.GeometryImportResponse(geometry_import_id=None, status=None, geometry_id=None, failure_reason=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'failure_reason': 'failureReason', 'geometry_id': 'geometryId', 'geometry_import_id': 'geometryImportId', 'status': 'status'}¶
- property failure_reason¶
Gets the failure_reason of this GeometryImportResponse. # noqa: E501
- Returns
The failure_reason of this GeometryImportResponse. # noqa: E501
- Return type
- property geometry_id¶
Gets the geometry_id of this GeometryImportResponse. # noqa: E501
The ID of the imported geometry when the import succeeded. # noqa: E501
- Returns
The geometry_id of this GeometryImportResponse. # noqa: E501
- Return type
str
- property geometry_import_id¶
Gets the geometry_import_id of this GeometryImportResponse. # noqa: E501
The ID of the geometry import operation. # noqa: E501
- Returns
The geometry_import_id of this GeometryImportResponse. # noqa: E501
- Return type
str
- openapi_types = {'failure_reason': 'LogEntry', 'geometry_id': 'str', 'geometry_import_id': 'str', 'status': 'Status'}¶
- property status¶
Gets the status of this GeometryImportResponse. # noqa: E501
- Returns
The status of this GeometryImportResponse. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_mappings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_mappings.GeometryMappings(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this GeometryMappings. # noqa: E501
- Returns
The embedded of this GeometryMappings. # noqa: E501
- Return type
list[EntityDescription]
- property links¶
Gets the links of this GeometryMappings. # noqa: E501
- Returns
The links of this GeometryMappings. # noqa: E501
- Return type
- property meta¶
Gets the meta of this GeometryMappings. # noqa: E501
- Returns
The meta of this GeometryMappings. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[EntityDescription]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_primitive module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_primitive.GeometryPrimitive(type='LOCAL_HALF_SPACE', id=None, name=None, min=None, max=None, rotation_point=None, rotation_angles=None, orientation_reference=None, center=None, radius=None, reference=None, axis=None, scale=None, translation=None, rotation_axis=None, rotation_angle=None, reference_point=None, normal=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'axis': 'axis', 'center': 'center', 'id': 'id', 'max': 'max', 'min': 'min', 'name': 'name', 'normal': 'normal', 'orientation_reference': 'orientationReference', 'radius': 'radius', 'reference': 'reference', 'reference_point': 'referencePoint', 'rotation_angle': 'rotationAngle', 'rotation_angles': 'rotationAngles', 'rotation_axis': 'rotationAxis', 'rotation_point': 'rotationPoint', 'scale': 'scale', 'translation': 'translation', 'type': 'type'}¶
- property axis¶
Gets the axis of this GeometryPrimitive. # noqa: E501
- Returns
The axis of this GeometryPrimitive. # noqa: E501
- Return type
- property center¶
Gets the center of this GeometryPrimitive. # noqa: E501
- Returns
The center of this GeometryPrimitive. # noqa: E501
- Return type
- discriminator_value_class_map = {'BOX': 'Box', 'CARTESIAN_BOX': 'CartesianBox', 'CYLINDER': 'Cylinder', 'HALF_SPACE': 'HalfSpace', 'LOCAL_CARTESIAN_BOX': 'LocalCartesianBox', 'LOCAL_HALF_SPACE': 'LocalHalfSpace', 'LOCAL_SPHERE': 'LocalSphere', 'POINT': 'Point', 'ROTATABLE_CARTESIAN_BOX': 'RotatableCartesianBox', 'SPHERE': 'Sphere'}¶
- get_real_child_model(data)¶
Returns the real base class specified by the discriminator
- property id¶
Gets the id of this GeometryPrimitive. # noqa: E501
- Returns
The id of this GeometryPrimitive. # noqa: E501
- Return type
str
- property max¶
Gets the max of this GeometryPrimitive. # noqa: E501
- Returns
The max of this GeometryPrimitive. # noqa: E501
- Return type
- property min¶
Gets the min of this GeometryPrimitive. # noqa: E501
- Returns
The min of this GeometryPrimitive. # noqa: E501
- Return type
- property name¶
Gets the name of this GeometryPrimitive. # noqa: E501
- Returns
The name of this GeometryPrimitive. # noqa: E501
- Return type
str
- property normal¶
Gets the normal of this GeometryPrimitive. # noqa: E501
- Returns
The normal of this GeometryPrimitive. # noqa: E501
- Return type
- openapi_types = {'axis': 'DimensionalVectorLength', 'center': 'DimensionalVectorLength', 'id': 'str', 'max': 'DimensionalVectorLength', 'min': 'DimensionalVectorLength', 'name': 'str', 'normal': 'DimensionalVectorLength', 'orientation_reference': 'str', 'radius': 'DimensionalLength', 'reference': 'DimensionalVectorLength', 'reference_point': 'DimensionalVectorLength', 'rotation_angle': 'DimensionalAngle', 'rotation_angles': 'DimensionalVectorAngle', 'rotation_axis': 'DimensionalVectorLength', 'rotation_point': 'DimensionalVectorLength', 'scale': 'DecimalVector', 'translation': 'DimensionalVectorLength', 'type': 'str'}¶
- property orientation_reference¶
Gets the orientation_reference of this GeometryPrimitive. # noqa: E501
- Returns
The orientation_reference of this GeometryPrimitive. # noqa: E501
- Return type
str
- property radius¶
Gets the radius of this GeometryPrimitive. # noqa: E501
- Returns
The radius of this GeometryPrimitive. # noqa: E501
- Return type
- property reference¶
Gets the reference of this GeometryPrimitive. # noqa: E501
- Returns
The reference of this GeometryPrimitive. # noqa: E501
- Return type
- property reference_point¶
Gets the reference_point of this GeometryPrimitive. # noqa: E501
- Returns
The reference_point of this GeometryPrimitive. # noqa: E501
- Return type
- property rotation_angle¶
Gets the rotation_angle of this GeometryPrimitive. # noqa: E501
- Returns
The rotation_angle of this GeometryPrimitive. # noqa: E501
- Return type
- property rotation_angles¶
Gets the rotation_angles of this GeometryPrimitive. # noqa: E501
- Returns
The rotation_angles of this GeometryPrimitive. # noqa: E501
- Return type
- property rotation_axis¶
Gets the rotation_axis of this GeometryPrimitive. # noqa: E501
- Returns
The rotation_axis of this GeometryPrimitive. # noqa: E501
- Return type
- property rotation_point¶
Gets the rotation_point of this GeometryPrimitive. # noqa: E501
- Returns
The rotation_point of this GeometryPrimitive. # noqa: E501
- Return type
- property scale¶
Gets the scale of this GeometryPrimitive. # noqa: E501
- Returns
The scale of this GeometryPrimitive. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property translation¶
Gets the translation of this GeometryPrimitive. # noqa: E501
- Returns
The translation of this GeometryPrimitive. # noqa: E501
- Return type
- property type¶
Gets the type of this GeometryPrimitive. # noqa: E501
Schema name: LocalHalfSpace # noqa: E501
- Returns
The type of this GeometryPrimitive. # noqa: E501
- Return type
str
simscale_sdk.models.geometry_primitive_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_primitive_response.GeometryPrimitiveResponse(geometry_primitive_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_id': 'geometryPrimitiveId'}¶
- property geometry_primitive_id¶
Gets the geometry_primitive_id of this GeometryPrimitiveResponse. # noqa: E501
The ID of the created geometry primitive. # noqa: E501
- Returns
The geometry_primitive_id of this GeometryPrimitiveResponse. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_id': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.geometry_unit module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.geometry_unit.GeometryUnit(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- CM = 'cm'¶
- FT = 'ft'¶
- IN = 'in'¶
- M = 'm'¶
- MM = 'mm'¶
- YD = 'yd'¶
- allowable_values = ['m', 'cm', 'mm', 'ft', 'in', 'yd']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.global_acceleration_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_acceleration_type.GlobalAccelerationType(type='GLOBAL', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalAccelerationType. # noqa: E501
- Returns
The complex_number of this GlobalAccelerationType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalAccelerationType. # noqa: E501
Schema name: GlobalAccelerationType # noqa: E501
- Returns
The type of this GlobalAccelerationType. # noqa: E501
- Return type
str
simscale_sdk.models.global_cauchy_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_cauchy_stress_type.GlobalCauchyStressType(type='CAUCHY', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalCauchyStressType. # noqa: E501
- Returns
The complex_number of this GlobalCauchyStressType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalCauchyStressType. # noqa: E501
Schema name: GlobalCauchyStressType # noqa: E501
- Returns
The type of this GlobalCauchyStressType. # noqa: E501
- Return type
str
simscale_sdk.models.global_displacement_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_displacement_type.GlobalDisplacementType(type='GLOBAL', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalDisplacementType. # noqa: E501
- Returns
The complex_number of this GlobalDisplacementType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalDisplacementType. # noqa: E501
Schema name: GlobalDisplacementType # noqa: E501
- Returns
The type of this GlobalDisplacementType. # noqa: E501
- Return type
str
simscale_sdk.models.global_nodal_force_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_nodal_force_type.GlobalNodalForceType(type='NODAL', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalNodalForceType. # noqa: E501
- Returns
The complex_number of this GlobalNodalForceType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalNodalForceType. # noqa: E501
Schema name: GlobalNodalForceType # noqa: E501
- Returns
The type of this GlobalNodalForceType. # noqa: E501
- Return type
str
simscale_sdk.models.global_principal_green_lagrange_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_principal_green_lagrange_strain_type.GlobalPrincipalGreenLagrangeStrainType(type='PRINCIPAL_GREEN_LAGRANGE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalPrincipalGreenLagrangeStrainType. # noqa: E501
Schema name: GlobalPrincipalGreenLagrangeStrainType # noqa: E501
- Returns
The type of this GlobalPrincipalGreenLagrangeStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.global_principal_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_principal_strain_type.GlobalPrincipalStrainType(type='PRINCIPAL', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalPrincipalStrainType. # noqa: E501
Schema name: GlobalPrincipalStrainType # noqa: E501
- Returns
The type of this GlobalPrincipalStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.global_principal_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_principal_stress_type.GlobalPrincipalStressType(type='PRINCIPAL', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalPrincipalStressType. # noqa: E501
Schema name: GlobalPrincipalStressType # noqa: E501
- Returns
The type of this GlobalPrincipalStressType. # noqa: E501
- Return type
str
simscale_sdk.models.global_reaction_force_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_reaction_force_type.GlobalReactionForceType(type='REACTION', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalReactionForceType. # noqa: E501
- Returns
The complex_number of this GlobalReactionForceType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalReactionForceType. # noqa: E501
Schema name: GlobalReactionForceType # noqa: E501
- Returns
The type of this GlobalReactionForceType. # noqa: E501
- Return type
str
simscale_sdk.models.global_signed_von_mises_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_signed_von_mises_stress_type.GlobalSignedVonMisesStressType(type='SIGNED_VON_MISES', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalSignedVonMisesStressType. # noqa: E501
Schema name: GlobalSignedVonMisesStressType # noqa: E501
- Returns
The type of this GlobalSignedVonMisesStressType. # noqa: E501
- Return type
str
simscale_sdk.models.global_total_equivalent_plastic_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_total_equivalent_plastic_strain_type.GlobalTotalEquivalentPlasticStrainType(type='TOTAL_EQUI_PLASTIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalTotalEquivalentPlasticStrainType. # noqa: E501
Schema name: GlobalTotalEquivalentPlasticStrainType # noqa: E501
- Returns
The type of this GlobalTotalEquivalentPlasticStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.global_total_nonlinear_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_total_nonlinear_strain_type.GlobalTotalNonlinearStrainType(type='TOTAL_NONLINEAR', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalTotalNonlinearStrainType. # noqa: E501
Schema name: GlobalTotalNonlinearStrainType # noqa: E501
- Returns
The type of this GlobalTotalNonlinearStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.global_total_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_total_strain_type.GlobalTotalStrainType(type='TOTAL', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalTotalStrainType. # noqa: E501
- Returns
The complex_number of this GlobalTotalStrainType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalTotalStrainType. # noqa: E501
Schema name: GlobalTotalStrainType # noqa: E501
- Returns
The type of this GlobalTotalStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.global_tresca_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_tresca_stress_type.GlobalTrescaStressType(type='TRESCA', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalTrescaStressType. # noqa: E501
Schema name: GlobalTrescaStressType # noqa: E501
- Returns
The type of this GlobalTrescaStressType. # noqa: E501
- Return type
str
simscale_sdk.models.global_unelastic_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_unelastic_strain_type.GlobalUnelasticStrainType(type='UNELASTIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalUnelasticStrainType. # noqa: E501
Schema name: GlobalUnelasticStrainType # noqa: E501
- Returns
The type of this GlobalUnelasticStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.global_velocity_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_velocity_type.GlobalVelocityType(type='GLOBAL', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalVelocityType. # noqa: E501
- Returns
The complex_number of this GlobalVelocityType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalVelocityType. # noqa: E501
Schema name: GlobalVelocityType # noqa: E501
- Returns
The type of this GlobalVelocityType. # noqa: E501
- Return type
str
simscale_sdk.models.global_von_mises_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.global_von_mises_stress_type.GlobalVonMisesStressType(type='VON_MISES', complex_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this GlobalVonMisesStressType. # noqa: E501
- Returns
The complex_number of this GlobalVonMisesStressType. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GlobalVonMisesStressType. # noqa: E501
Schema name: GlobalVonMisesStressType # noqa: E501
- Returns
The type of this GlobalVonMisesStressType. # noqa: E501
- Return type
str
simscale_sdk.models.gradient_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.gradient_schemes.GradientSchemes(for_default=None, grad_pressure=None, grad_velocity=None, grad_pressure_rgh=None, grad_density=None, grad_enthalpy=None, grad_internal_energy=None, grad_turbulent_kinetic_energy=None, grad_epsilon_dissipation_rate=None, grad_omega_dissipation_rate=None, grad_nu_tilda=None, grad_temperature=None, grad_rhok=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'for_default': 'forDefault', 'grad_density': 'grad_density', 'grad_enthalpy': 'grad_enthalpy', 'grad_epsilon_dissipation_rate': 'grad_epsilonDissipationRate', 'grad_internal_energy': 'grad_internalEnergy', 'grad_nu_tilda': 'grad_nuTilda', 'grad_omega_dissipation_rate': 'grad_omegaDissipationRate', 'grad_pressure': 'grad_pressure', 'grad_pressure_rgh': 'grad_pressureRgh', 'grad_rhok': 'grad_rhok', 'grad_temperature': 'grad_temperature', 'grad_turbulent_kinetic_energy': 'grad_turbulentKineticEnergy', 'grad_velocity': 'grad_velocity'}¶
- property for_default¶
Gets the for_default of this GradientSchemes. # noqa: E501
- Returns
The for_default of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesForDefault
- property grad_density¶
Gets the grad_density of this GradientSchemes. # noqa: E501
- Returns
The grad_density of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradDensity
- property grad_enthalpy¶
Gets the grad_enthalpy of this GradientSchemes. # noqa: E501
- Returns
The grad_enthalpy of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradEnthalpy
- property grad_epsilon_dissipation_rate¶
Gets the grad_epsilon_dissipation_rate of this GradientSchemes. # noqa: E501
- Returns
The grad_epsilon_dissipation_rate of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradEpsilonDissipationRate
- property grad_internal_energy¶
Gets the grad_internal_energy of this GradientSchemes. # noqa: E501
- Returns
The grad_internal_energy of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradInternalEnergy
- property grad_nu_tilda¶
Gets the grad_nu_tilda of this GradientSchemes. # noqa: E501
- Returns
The grad_nu_tilda of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradNuTilda
- property grad_omega_dissipation_rate¶
Gets the grad_omega_dissipation_rate of this GradientSchemes. # noqa: E501
- Returns
The grad_omega_dissipation_rate of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradOmegaDissipationRate
- property grad_pressure¶
Gets the grad_pressure of this GradientSchemes. # noqa: E501
- Returns
The grad_pressure of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradPressure
- property grad_pressure_rgh¶
Gets the grad_pressure_rgh of this GradientSchemes. # noqa: E501
- Returns
The grad_pressure_rgh of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradPressureRgh
- property grad_rhok¶
Gets the grad_rhok of this GradientSchemes. # noqa: E501
- Returns
The grad_rhok of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradRhok
- property grad_temperature¶
Gets the grad_temperature of this GradientSchemes. # noqa: E501
- Returns
The grad_temperature of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradTemperature
- property grad_turbulent_kinetic_energy¶
Gets the grad_turbulent_kinetic_energy of this GradientSchemes. # noqa: E501
- Returns
The grad_turbulent_kinetic_energy of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradTurbulentKineticEnergy
- property grad_velocity¶
Gets the grad_velocity of this GradientSchemes. # noqa: E501
- Returns
The grad_velocity of this GradientSchemes. # noqa: E501
- Return type
OneOfGradientSchemesGradVelocity
- openapi_types = {'for_default': 'OneOfGradientSchemesForDefault', 'grad_density': 'OneOfGradientSchemesGradDensity', 'grad_enthalpy': 'OneOfGradientSchemesGradEnthalpy', 'grad_epsilon_dissipation_rate': 'OneOfGradientSchemesGradEpsilonDissipationRate', 'grad_internal_energy': 'OneOfGradientSchemesGradInternalEnergy', 'grad_nu_tilda': 'OneOfGradientSchemesGradNuTilda', 'grad_omega_dissipation_rate': 'OneOfGradientSchemesGradOmegaDissipationRate', 'grad_pressure': 'OneOfGradientSchemesGradPressure', 'grad_pressure_rgh': 'OneOfGradientSchemesGradPressureRgh', 'grad_rhok': 'OneOfGradientSchemesGradRhok', 'grad_temperature': 'OneOfGradientSchemesGradTemperature', 'grad_turbulent_kinetic_energy': 'OneOfGradientSchemesGradTurbulentKineticEnergy', 'grad_velocity': 'OneOfGradientSchemesGradVelocity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.greybody_diffusive_ray_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.greybody_diffusive_ray_bc.GreybodyDiffusiveRayBC(type='GREYBODY_DIFFUSIVE_RAY', emissivity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'emissivity': 'emissivity', 'type': 'type'}¶
- property emissivity¶
Gets the emissivity of this GreybodyDiffusiveRayBC. # noqa: E501
- Returns
The emissivity of this GreybodyDiffusiveRayBC. # noqa: E501
- Return type
float
- openapi_types = {'emissivity': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GreybodyDiffusiveRayBC. # noqa: E501
Schema name: GreybodyDiffusiveRayBC # noqa: E501
- Returns
The type of this GreybodyDiffusiveRayBC. # noqa: E501
- Return type
str
simscale_sdk.models.greybody_diffusive_rsbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.greybody_diffusive_rsbc.GreybodyDiffusiveRSBC(type='GREYBODY_DIFFUSIVE', emissivity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'emissivity': 'emissivity', 'type': 'type'}¶
- property emissivity¶
Gets the emissivity of this GreybodyDiffusiveRSBC. # noqa: E501
- Returns
The emissivity of this GreybodyDiffusiveRSBC. # noqa: E501
- Return type
- openapi_types = {'emissivity': 'DimensionalDimensionless', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GreybodyDiffusiveRSBC. # noqa: E501
Schema name: GreybodyDiffusiveRSBC # noqa: E501
- Returns
The type of this GreybodyDiffusiveRSBC. # noqa: E501
- Return type
str
simscale_sdk.models.ground_absolute module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ground_absolute.GroundAbsolute(type='GROUND_ABSOLUTE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this GroundAbsolute. # noqa: E501
Schema name: GroundAbsolute # noqa: E501
- Returns
The type of this GroundAbsolute. # noqa: E501
- Return type
str
simscale_sdk.models.ground_relative module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ground_relative.GroundRelative(type='GROUND_RELATIVE', topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'topological_reference': 'topologicalReference', 'type': 'type'}¶
- openapi_types = {'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this GroundRelative. # noqa: E501
- Returns
The topological_reference of this GroundRelative. # noqa: E501
- Return type
- property type¶
Gets the type of this GroundRelative. # noqa: E501
Schema name: GroundRelative # noqa: E501
- Returns
The type of this GroundRelative. # noqa: E501
- Return type
str
simscale_sdk.models.h_const_thermo module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.h_const_thermo.HConstThermo(type='HCONST', specific_heat=None, equation_of_state=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'equation_of_state': 'equationOfState', 'specific_heat': 'specificHeat', 'type': 'type'}¶
- property equation_of_state¶
Gets the equation_of_state of this HConstThermo. # noqa: E501
- Returns
The equation_of_state of this HConstThermo. # noqa: E501
- Return type
OneOfHConstThermoEquationOfState
- openapi_types = {'equation_of_state': 'OneOfHConstThermoEquationOfState', 'specific_heat': 'DimensionalSpecificHeat', 'type': 'str'}¶
- property specific_heat¶
Gets the specific_heat of this HConstThermo. # noqa: E501
- Returns
The specific_heat of this HConstThermo. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HConstThermo. # noqa: E501
<br><p>The <b>Thermo models</b> are used to calculate the specific heat at constant pressure (<i>Cp</i>) for the fluid. The available models are:</p><p><b>hConst:</b> This model assumes a constant value for specific heat at fixed pressure (<i>Cp</i>). </p><p><b>eConst:</b> This model assumes a constant value for the specific heat at fixed volume (<i>Cv</i>). </p> Schema name: HConstThermo # noqa: E501
- Returns
The type of this HConstThermo. # noqa: E501
- Return type
str
simscale_sdk.models.half_space module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.half_space.HalfSpace(type='HALF_SPACE', id=None, name=None, reference_point=None, normal=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'name': 'name', 'normal': 'normal', 'reference_point': 'referencePoint', 'type': 'type'}¶
- property id¶
Gets the id of this HalfSpace. # noqa: E501
- Returns
The id of this HalfSpace. # noqa: E501
- Return type
str
- property name¶
Gets the name of this HalfSpace. # noqa: E501
- Returns
The name of this HalfSpace. # noqa: E501
- Return type
str
- property normal¶
Gets the normal of this HalfSpace. # noqa: E501
- Returns
The normal of this HalfSpace. # noqa: E501
- Return type
- openapi_types = {'id': 'str', 'name': 'str', 'normal': 'DimensionalVectorLength', 'reference_point': 'DimensionalVectorLength', 'type': 'str'}¶
- property reference_point¶
Gets the reference_point of this HalfSpace. # noqa: E501
- Returns
The reference_point of this HalfSpace. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HalfSpace. # noqa: E501
Schema name: HalfSpace # noqa: E501
- Returns
The type of this HalfSpace. # noqa: E501
- Return type
str
simscale_sdk.models.harmonic_analysis module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.harmonic_analysis.HarmonicAnalysis(type='HARMONIC_ANALYSIS', connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'element_technology': 'elementTechnology', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'mesh_order': 'meshOrder', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this HarmonicAnalysis. # noqa: E501
- Returns
The boundary_conditions of this HarmonicAnalysis. # noqa: E501
- Return type
list[OneOfHarmonicAnalysisBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this HarmonicAnalysis. # noqa: E501
- Returns
The connection_groups of this HarmonicAnalysis. # noqa: E501
- Return type
list[Contact]
- property element_technology¶
Gets the element_technology of this HarmonicAnalysis. # noqa: E501
- Returns
The element_technology of this HarmonicAnalysis. # noqa: E501
- Return type
- property initial_conditions¶
Gets the initial_conditions of this HarmonicAnalysis. # noqa: E501
- Returns
The initial_conditions of this HarmonicAnalysis. # noqa: E501
- Return type
- property materials¶
Gets the materials of this HarmonicAnalysis. # noqa: E501
- Returns
The materials of this HarmonicAnalysis. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this HarmonicAnalysis. # noqa: E501
- Returns
The mesh_order of this HarmonicAnalysis. # noqa: E501
- Return type
str
- property model¶
Gets the model of this HarmonicAnalysis. # noqa: E501
- Returns
The model of this HarmonicAnalysis. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this HarmonicAnalysis. # noqa: E501
- Returns
The numerics of this HarmonicAnalysis. # noqa: E501
- Return type
- openapi_types = {'boundary_conditions': 'list[OneOfHarmonicAnalysisBoundaryConditions]', 'connection_groups': 'list[Contact]', 'element_technology': 'SolidElementTechnology', 'initial_conditions': 'SolidInitialConditions', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'model': 'SolidModel', 'numerics': 'SolidNumerics', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this HarmonicAnalysis. # noqa: E501
- Returns
The result_control of this HarmonicAnalysis. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this HarmonicAnalysis. # noqa: E501
- Returns
The simulation_control of this HarmonicAnalysis. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HarmonicAnalysis. # noqa: E501
Schema name: HarmonicAnalysis # noqa: E501
- Returns
The type of this HarmonicAnalysis. # noqa: E501
- Return type
str
simscale_sdk.models.harmonic_response_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.harmonic_response_result_control_item.HarmonicResponseResultControlItem(type='HARMONIC_RESPONSE', name=None, field_selection=None, complex_number=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'complex_number': 'complexNumber', 'field_selection': 'fieldSelection', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'type': 'type'}¶
- property complex_number¶
Gets the complex_number of this HarmonicResponseResultControlItem. # noqa: E501
- Returns
The complex_number of this HarmonicResponseResultControlItem. # noqa: E501
- Return type
str
- property field_selection¶
Gets the field_selection of this HarmonicResponseResultControlItem. # noqa: E501
- Returns
The field_selection of this HarmonicResponseResultControlItem. # noqa: E501
- Return type
OneOfHarmonicResponseResultControlItemFieldSelection
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this HarmonicResponseResultControlItem. # noqa: E501
- Returns
The geometry_primitive_uuids of this HarmonicResponseResultControlItem. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this HarmonicResponseResultControlItem. # noqa: E501
- Returns
The name of this HarmonicResponseResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'complex_number': 'str', 'field_selection': 'OneOfHarmonicResponseResultControlItemFieldSelection', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HarmonicResponseResultControlItem. # noqa: E501
Schema name: HarmonicResponseResultControlItem # noqa: E501
- Returns
The type of this HarmonicResponseResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.heat_flux_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.heat_flux_field_selection.HeatFluxFieldSelection(type='HEAT_FLUX', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this HeatFluxFieldSelection. # noqa: E501
- Returns
The component_selection of this HeatFluxFieldSelection. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HeatFluxFieldSelection. # noqa: E501
Schema name: HeatFluxFieldSelection # noqa: E501
- Returns
The type of this HeatFluxFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.heat_flux_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.heat_flux_result_control_item.HeatFluxResultControlItem(type='HEAT_FLUX', name=None, heat_flux_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heat_flux_type': 'heatFluxType', 'name': 'name', 'type': 'type'}¶
- property heat_flux_type¶
Gets the heat_flux_type of this HeatFluxResultControlItem. # noqa: E501
- Returns
The heat_flux_type of this HeatFluxResultControlItem. # noqa: E501
- Return type
str
- property name¶
Gets the name of this HeatFluxResultControlItem. # noqa: E501
- Returns
The name of this HeatFluxResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'heat_flux_type': 'str', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HeatFluxResultControlItem. # noqa: E501
Schema name: HeatFluxResultControlItem # noqa: E501
- Returns
The type of this HeatFluxResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.heat_transfer module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.heat_transfer.HeatTransfer(type='HEAT_TRANSFER', time_dependency=None, non_linear_analysis=None, connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'element_technology': 'elementTechnology', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'mesh_order': 'meshOrder', 'model': 'model', 'non_linear_analysis': 'nonLinearAnalysis', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this HeatTransfer. # noqa: E501
- Returns
The boundary_conditions of this HeatTransfer. # noqa: E501
- Return type
list[OneOfHeatTransferBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this HeatTransfer. # noqa: E501
- Returns
The connection_groups of this HeatTransfer. # noqa: E501
- Return type
list[Contact]
- property element_technology¶
Gets the element_technology of this HeatTransfer. # noqa: E501
- Returns
The element_technology of this HeatTransfer. # noqa: E501
- Return type
- property initial_conditions¶
Gets the initial_conditions of this HeatTransfer. # noqa: E501
- Returns
The initial_conditions of this HeatTransfer. # noqa: E501
- Return type
- property materials¶
Gets the materials of this HeatTransfer. # noqa: E501
- Returns
The materials of this HeatTransfer. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this HeatTransfer. # noqa: E501
- Returns
The mesh_order of this HeatTransfer. # noqa: E501
- Return type
str
- property model¶
Gets the model of this HeatTransfer. # noqa: E501
- Returns
The model of this HeatTransfer. # noqa: E501
- Return type
- property non_linear_analysis¶
Gets the non_linear_analysis of this HeatTransfer. # noqa: E501
<p>Choose if your analysis should feature any kind of <b>nonlinearity</b> like <b>physical contacts, nonlinear materials</b> as hyperelasticity or plasticity or <b>large rotations</b> and <b>large deformations, temperature dependant material properties</b> or <b>temperature dependant boundary conditions</b>. For a <b>linear analysis</b> none of those nonlinearities are available.</p> # noqa: E501
- Returns
The non_linear_analysis of this HeatTransfer. # noqa: E501
- Return type
bool
- property numerics¶
Gets the numerics of this HeatTransfer. # noqa: E501
- Returns
The numerics of this HeatTransfer. # noqa: E501
- Return type
- openapi_types = {'boundary_conditions': 'list[OneOfHeatTransferBoundaryConditions]', 'connection_groups': 'list[Contact]', 'element_technology': 'SolidElementTechnology', 'initial_conditions': 'SolidInitialConditions', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'model': 'SolidModel', 'non_linear_analysis': 'bool', 'numerics': 'SolidNumerics', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'time_dependency': 'OneOfHeatTransferTimeDependency', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this HeatTransfer. # noqa: E501
- Returns
The result_control of this HeatTransfer. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this HeatTransfer. # noqa: E501
- Returns
The simulation_control of this HeatTransfer. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this HeatTransfer. # noqa: E501
- Returns
The time_dependency of this HeatTransfer. # noqa: E501
- Return type
OneOfHeatTransferTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HeatTransfer. # noqa: E501
Schema name: HeatTransfer # noqa: E501
- Returns
The type of this HeatTransfer. # noqa: E501
- Return type
str
simscale_sdk.models.herschel_bulkley_viscosity_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.herschel_bulkley_viscosity_model.HerschelBulkleyViscosityModel(type='HERSCHEL_BULKLEY', k=None, n=None, tau0=None, nu0=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'k': 'k', 'n': 'n', 'nu0': 'nu0', 'tau0': 'tau0', 'type': 'type'}¶
- property k¶
Gets the k of this HerschelBulkleyViscosityModel. # noqa: E501
- Returns
The k of this HerschelBulkleyViscosityModel. # noqa: E501
- Return type
- property n¶
Gets the n of this HerschelBulkleyViscosityModel. # noqa: E501
- Returns
The n of this HerschelBulkleyViscosityModel. # noqa: E501
- Return type
- property nu0¶
Gets the nu0 of this HerschelBulkleyViscosityModel. # noqa: E501
- Returns
The nu0 of this HerschelBulkleyViscosityModel. # noqa: E501
- Return type
- openapi_types = {'k': 'DimensionalKinematicViscosity', 'n': 'DimensionalDimensionless', 'nu0': 'DimensionalKinematicViscosity', 'tau0': 'DimensionalTurbulenceKineticEnergy', 'type': 'str'}¶
- property tau0¶
Gets the tau0 of this HerschelBulkleyViscosityModel. # noqa: E501
- Returns
The tau0 of this HerschelBulkleyViscosityModel. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HerschelBulkleyViscosityModel. # noqa: E501
Choose between <a href=’https://www.simscale.com/docs/simulation-setup/materials/#newtonian-model’ target=’_blank’>Newtonian</a> and <a href=’https://www.simscale.com/docs/simulation-setup/materials/non-newtonian-models/’ target=’_blank’>Non-Newtonian</a> viscosity models. Schema name: HerschelBulkleyViscosityModel # noqa: E501
- Returns
The type of this HerschelBulkleyViscosityModel. # noqa: E501
- Return type
str
simscale_sdk.models.hex_dominant_snappy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.hex_dominant_snappy.HexDominantSnappy(type='HEX_DOMINANT_SNAPPY_V5', meshing_mode=None, sizing=None, physics_based_meshing=None, num_of_processors=None, refinements=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'meshing_mode': 'meshingMode', 'num_of_processors': 'numOfProcessors', 'physics_based_meshing': 'physicsBasedMeshing', 'refinements': 'refinements', 'sizing': 'sizing', 'type': 'type'}¶
- property meshing_mode¶
Gets the meshing_mode of this HexDominantSnappy. # noqa: E501
<p>The <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#meshing-mode’ target=’_blank’>meshing mode</a> defines how the mesher should generate the mesh.</p><ul><li>The <b>Internal</b> mode will create the mesh <u>inside</u> of the geometry body. If the CAD consists of multiple solids, the mesher will attempt to create a multiregion mesh which is suitable for conjugate heat transfer analyses. Use this mode if the CAD model already represents the final fluid domain.</li><li><b>External</b> meshing will create the mesh <u>outside</u> of the bodies. The absolute dimensions of the mesh are determined by the <i>Background Mesh Box</i>. Use this mode in case you want to extract the fluid domain around your model.</li><li>The option <b>Material point</b> allows you to define a point inside the domain where the mesh will be placed. It can be used to select which part (or enclosed volume) of the model or should be meshed. The mesh will surround the material point and extend until the boundaries of the body. The location of the material point is defined by the <i>Material Point</i> geometry primitive.</li></ul> # noqa: E501
- Returns
The meshing_mode of this HexDominantSnappy. # noqa: E501
- Return type
str
- property num_of_processors¶
Gets the num_of_processors of this HexDominantSnappy. # noqa: E501
<p>Selecting more processor cores might speed up the meshing process. Choosing a smaller computation instance will save core hours. <a href=’https://www.simscale.com/docs/simulation-setup/meshing/#number-of-processors’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The num_of_processors of this HexDominantSnappy. # noqa: E501
- Return type
int
- openapi_types = {'meshing_mode': 'str', 'num_of_processors': 'int', 'physics_based_meshing': 'bool', 'refinements': 'list[OneOfHexDominantSnappyRefinements]', 'sizing': 'OneOfHexDominantSnappySizing', 'type': 'str'}¶
- property physics_based_meshing¶
Gets the physics_based_meshing of this HexDominantSnappy. # noqa: E501
Physics-based meshing takes setup information like materials, boundary conditions, and source terms into account to size the mesh accordingly. When enabled, the following adaptations will be made:</p><ul><li>Refinements on inlets and outlets</li><li>Different sizing for solid and fluid regions in CHT simulations</li></ul> <br>When toggled on users don’t have to worry about creating a <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control/’ target=’_blank’>separate cell zone</a>. # noqa: E501
- Returns
The physics_based_meshing of this HexDominantSnappy. # noqa: E501
- Return type
bool
- property refinements¶
Gets the refinements of this HexDominantSnappy. # noqa: E501
- Returns
The refinements of this HexDominantSnappy. # noqa: E501
- Return type
list[OneOfHexDominantSnappyRefinements]
- property sizing¶
Gets the sizing of this HexDominantSnappy. # noqa: E501
- Returns
The sizing of this HexDominantSnappy. # noqa: E501
- Return type
OneOfHexDominantSnappySizing
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HexDominantSnappy. # noqa: E501
Schema name: HexDominantSnappy # noqa: E501
- Returns
The type of this HexDominantSnappy. # noqa: E501
- Return type
str
simscale_sdk.models.hht_time_integration_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.hht_time_integration_scheme.HhtTimeIntegrationScheme(type='HHT', alpha=None, method=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property alpha¶
Gets the alpha of this HhtTimeIntegrationScheme. # noqa: E501
The parameter <b>α</b> is given by a negative value. The larger |<b>α</b>| is, the more numerical damping is induced. # noqa: E501
- Returns
The alpha of this HhtTimeIntegrationScheme. # noqa: E501
- Return type
float
- attribute_map = {'alpha': 'alpha', 'method': 'method', 'type': 'type'}¶
- property method¶
Gets the method of this HhtTimeIntegrationScheme. # noqa: E501
Choose the mode of the HHT method. Compared to the <b>average acceleration</b> scheme the induced numerical damping of the <b>alpha method</b> is more selective: it is weaker for low frequencies and it will increase with the frequencies. # noqa: E501
- Returns
The method of this HhtTimeIntegrationScheme. # noqa: E501
- Return type
str
- openapi_types = {'alpha': 'float', 'method': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HhtTimeIntegrationScheme. # noqa: E501
Schema name: HhtTimeIntegrationScheme # noqa: E501
- Returns
The type of this HhtTimeIntegrationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.hierarchical_decompose_algorithm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.hierarchical_decompose_algorithm.HierarchicalDecomposeAlgorithm(type='HIERARCHICAL', decomposition_order=None, delta=None, num_subdomain_x=None, num_subdomain_y=None, num_subdomain_z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'decomposition_order': 'decompositionOrder', 'delta': 'delta', 'num_subdomain_x': 'numSubdomainX', 'num_subdomain_y': 'numSubdomainY', 'num_subdomain_z': 'numSubdomainZ', 'type': 'type'}¶
- property decomposition_order¶
Gets the decomposition_order of this HierarchicalDecomposeAlgorithm. # noqa: E501
<p>Choose the order of domain decomposition .</p> # noqa: E501
- Returns
The decomposition_order of this HierarchicalDecomposeAlgorithm. # noqa: E501
- Return type
str
- property delta¶
Gets the delta of this HierarchicalDecomposeAlgorithm. # noqa: E501
Delta is cell skew factor. It represents the cell skewness allowed at the decomposed domain boundaries and is generally kept below 10^{-2}. <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The delta of this HierarchicalDecomposeAlgorithm. # noqa: E501
- Return type
float
- property num_subdomain_x¶
Gets the num_subdomain_x of this HierarchicalDecomposeAlgorithm. # noqa: E501
<p>Define the number of subdomains the mesh is split into in the specific direction.</p> # noqa: E501
- Returns
The num_subdomain_x of this HierarchicalDecomposeAlgorithm. # noqa: E501
- Return type
int
- property num_subdomain_y¶
Gets the num_subdomain_y of this HierarchicalDecomposeAlgorithm. # noqa: E501
<p>Define the number of subdomains the mesh is split into in the specific direction.</p> # noqa: E501
- Returns
The num_subdomain_y of this HierarchicalDecomposeAlgorithm. # noqa: E501
- Return type
int
- property num_subdomain_z¶
Gets the num_subdomain_z of this HierarchicalDecomposeAlgorithm. # noqa: E501
<p>Define the number of subdomains the mesh is split into in the specific direction.</p> # noqa: E501
- Returns
The num_subdomain_z of this HierarchicalDecomposeAlgorithm. # noqa: E501
- Return type
int
- openapi_types = {'decomposition_order': 'str', 'delta': 'float', 'num_subdomain_x': 'int', 'num_subdomain_y': 'int', 'num_subdomain_z': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HierarchicalDecomposeAlgorithm. # noqa: E501
Schema name: HierarchicalDecomposeAlgorithm # noqa: E501
- Returns
The type of this HierarchicalDecomposeAlgorithm. # noqa: E501
- Return type
str
simscale_sdk.models.high_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.high_resolution.HighResolution(type='HIGH_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HighResolution. # noqa: E501
Output will be written every 2 time steps. Schema name: HighResolution # noqa: E501
- Returns
The type of this HighResolution. # noqa: E501
- Return type
str
simscale_sdk.models.hyper_elastic_material_behavior module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.hyper_elastic_material_behavior.HyperElasticMaterialBehavior(type='HYPER_ELASTIC', hyper_elastic_model=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'hyper_elastic_model': 'hyperElasticModel', 'type': 'type'}¶
- property hyper_elastic_model¶
Gets the hyper_elastic_model of this HyperElasticMaterialBehavior. # noqa: E501
- Returns
The hyper_elastic_model of this HyperElasticMaterialBehavior. # noqa: E501
- Return type
OneOfHyperElasticMaterialBehaviorHyperElasticModel
- openapi_types = {'hyper_elastic_model': 'OneOfHyperElasticMaterialBehaviorHyperElasticModel', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HyperElasticMaterialBehavior. # noqa: E501
<p>Choose the material behavior for your problem. </p> <br /><br />Important remarks:<br /> <ul><li>Choose <b>Linear elastic</b> if the stress-strain relationship of your material is linear.</li><li>Choose <b>Elasto-plastic</b> if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.</li><li>Choose <b>Hyperelastic</b> if your material responds elastically even at higher deformations.</li></ul> Schema name: HyperElasticMaterialBehavior # noqa: E501
- Returns
The type of this HyperElasticMaterialBehavior. # noqa: E501
- Return type
str
simscale_sdk.models.hysteretic_damping module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.hysteretic_damping.HystereticDamping(type='HYSTERETIC', hysteretic_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'hysteretic_coefficient': 'hystereticCoefficient', 'type': 'type'}¶
- property hysteretic_coefficient¶
Gets the hysteretic_coefficient of this HystereticDamping. # noqa: E501
<p>Set the hysteretic damping coefficient <b>κ</b> of the material. The system equation is then: <b>M*ü+K*(1+i*κ)*u = f</b>.</p> # noqa: E501
- Returns
The hysteretic_coefficient of this HystereticDamping. # noqa: E501
- Return type
float
- openapi_types = {'hysteretic_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this HystereticDamping. # noqa: E501
<p>Choose if damping effects should be considered. The supported damping types are:<ul><li><p><b>Rayleigh Damping</b> which is also known as <i>proportional viscous damping</i>. This model assumes that the damping is proportional to the vibrating velocity.</p></ul><ul><li><p><b>Hysteretic Damping</b>, also known as <i>structural damping</i>. Here the damping is assumed to be proportional to the displacement.</p></ul><br><a href= https://www.simscale.com/docs/simulation-setup/materials/damping/’ target=’_blank’>Learn more</a>. Schema name: HystereticDamping # noqa: E501
- Returns
The type of this HystereticDamping. # noqa: E501
- Return type
str
simscale_sdk.models.ilu_cp_preconditioner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ilu_cp_preconditioner.ILUCpPreconditioner(type='ILUCP', fill_in_level=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fill_in_level': 'fillInLevel', 'type': 'type'}¶
- property fill_in_level¶
Gets the fill_in_level of this ILUCpPreconditioner. # noqa: E501
Number of face-neighbour layers to fill in. Increasing the level of fill-in improves the performance of preconditioner at the expense of computational overhead. # noqa: E501
- Returns
The fill_in_level of this ILUCpPreconditioner. # noqa: E501
- Return type
int
- openapi_types = {'fill_in_level': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ILUCpPreconditioner. # noqa: E501
Crout’s version of the incomplete lower-upper (ILU) algorithm with arbitrary level of fill-in. Schema name: ILUCpPreconditioner # noqa: E501
- Returns
The type of this ILUCpPreconditioner. # noqa: E501
- Return type
str
simscale_sdk.models.implicit_time_integration_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.implicit_time_integration_type.ImplicitTimeIntegrationType(type='IMPLICIT', scheme=None, scheme_formulation=None, mass_matrix_shift=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mass_matrix_shift': 'massMatrixShift', 'scheme': 'scheme', 'scheme_formulation': 'schemeFormulation', 'type': 'type'}¶
- property mass_matrix_shift¶
Gets the mass_matrix_shift of this ImplicitTimeIntegrationType. # noqa: E501
<p>This parameter c<sub>K</sub> allows the shifting of the mass matrix with the stiffness matrix multiplied by c<sub>K</sub>: <b>M</b><sup>’</sup>=<b>M</b> + c<sub>K</sub>*<b>K</b>. This makes it possible to strongly improve convergence in dynamics with implicit time scheme by imposing a cut-off frequency inversely proportional to the value of c<sub>K</sub> (at the cost of a light distortion of all the eigen frequencies of the system).</p> # noqa: E501
- Returns
The mass_matrix_shift of this ImplicitTimeIntegrationType. # noqa: E501
- Return type
float
- openapi_types = {'mass_matrix_shift': 'float', 'scheme': 'OneOfImplicitTimeIntegrationTypeScheme', 'scheme_formulation': 'str', 'type': 'str'}¶
- property scheme¶
Gets the scheme of this ImplicitTimeIntegrationType. # noqa: E501
- Returns
The scheme of this ImplicitTimeIntegrationType. # noqa: E501
- Return type
OneOfImplicitTimeIntegrationTypeScheme
- property scheme_formulation¶
Gets the scheme_formulation of this ImplicitTimeIntegrationType. # noqa: E501
<p>Choose the primary variable for the time integration scheme.</p> # noqa: E501
- Returns
The scheme_formulation of this ImplicitTimeIntegrationType. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ImplicitTimeIntegrationType. # noqa: E501
<p>Choose the time integration scheme type</p><br /><br />Important remarks:<br /><ul><li>Choose <b>implicit</b> if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme. </li><i>Choose <b>explicit</b> if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it’s not recommended due to convergence problems. </i></ul> Schema name: ImplicitTimeIntegrationType # noqa: E501
- Returns
The type of this ImplicitTimeIntegrationType. # noqa: E501
- Return type
str
simscale_sdk.models.inactive_adjustable_timestep module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inactive_adjustable_timestep.InactiveAdjustableTimestep(type='INACTIVE_TIMESTEP', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InactiveAdjustableTimestep. # noqa: E501
This option activates an adjustable time step. The time step is being modified according to the Courant number. Schema name: InactiveAdjustableTimestep # noqa: E501
- Returns
The type of this InactiveAdjustableTimestep. # noqa: E501
- Return type
str
simscale_sdk.models.inactive_preconditioner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inactive_preconditioner.InactivePreconditioner(type='INACTIVE', renumbering_method=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'renumbering_method': 'renumberingMethod', 'type': 'type'}¶
- openapi_types = {'renumbering_method': 'str', 'type': 'str'}¶
- property renumbering_method¶
Gets the renumbering_method of this InactivePreconditioner. # noqa: E501
Choose the renumbering method for the system matrix entries:<ul><li><p><b>RCMK</b> uses the algorithm of <i>Reverse Cuthill-MacKee</i> for the renumbering. It often effectively reduces the matrig storage space and the matrix factorization time.</p></ul><ul><li><p>When <b>inactive</b> is selected no renumbering is done. This option should only be chosen for testing purposes.</p></ul> # noqa: E501
- Returns
The renumbering_method of this InactivePreconditioner. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InactivePreconditioner. # noqa: E501
Schema name: InactivePreconditioner # noqa: E501
- Returns
The type of this InactivePreconditioner. # noqa: E501
- Return type
str
simscale_sdk.models.incomplete_preconditioner_v33 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.incomplete_preconditioner_v33.IncompletePreconditionerV33(type='INCOMPLETE_LDLT_V33', matrix_completeness=None, preconditioner_matrix_growth=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'matrix_completeness': 'matrixCompleteness', 'preconditioner_matrix_growth': 'preconditionerMatrixGrowth', 'type': 'type'}¶
- property matrix_completeness¶
Gets the matrix_completeness of this IncompletePreconditionerV33. # noqa: E501
Set the level of completeness for the incomplete Cholesky decomposition. The larger this value is, the better the preconditioning Matrix P approximates K<sup>-1</sup>, but also the memory usage and computation time increase. If the solution does not converge or uses a lot of iterations it could help to increase this parameter. # noqa: E501
- Returns
The matrix_completeness of this IncompletePreconditionerV33. # noqa: E501
- Return type
int
- openapi_types = {'matrix_completeness': 'int', 'preconditioner_matrix_growth': 'float', 'type': 'str'}¶
- property preconditioner_matrix_growth¶
Gets the preconditioner_matrix_growth of this IncompletePreconditionerV33. # noqa: E501
Set the growth rate of the filling for the incomplete decomposition matrix. If this parameter is set to 1.0 PETSc estimates the matrix storage size from the first level of completeness. If this estimate is too low, PETSC increases the allocated memory on the fly, but this is more expensive. # noqa: E501
- Returns
The preconditioner_matrix_growth of this IncompletePreconditionerV33. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IncompletePreconditionerV33. # noqa: E501
Schema name: IncompletePreconditionerV33 # noqa: E501
- Returns
The type of this IncompletePreconditionerV33. # noqa: E501
- Return type
str
simscale_sdk.models.incompressible module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.incompressible.Incompressible(type='INCOMPRESSIBLE', turbulence_model=None, time_dependency=None, algorithm=None, num_of_passive_species=None, enable_adjoint_optimization=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this Incompressible. # noqa: E501
- Returns
The advanced_concepts of this Incompressible. # noqa: E501
- Return type
- property algorithm¶
Gets the algorithm of this Incompressible. # noqa: E501
- Returns
The algorithm of this Incompressible. # noqa: E501
- Return type
str
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'algorithm': 'algorithm', 'boundary_conditions': 'boundaryConditions', 'enable_adjoint_optimization': 'enableAdjointOptimization', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'model': 'model', 'num_of_passive_species': 'numOfPassiveSpecies', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this Incompressible. # noqa: E501
- Returns
The boundary_conditions of this Incompressible. # noqa: E501
- Return type
list[OneOfIncompressibleBoundaryConditions]
- property enable_adjoint_optimization¶
Gets the enable_adjoint_optimization of this Incompressible. # noqa: E501
- Returns
The enable_adjoint_optimization of this Incompressible. # noqa: E501
- Return type
bool
- property initial_conditions¶
Gets the initial_conditions of this Incompressible. # noqa: E501
- Returns
The initial_conditions of this Incompressible. # noqa: E501
- Return type
- property materials¶
Gets the materials of this Incompressible. # noqa: E501
- Returns
The materials of this Incompressible. # noqa: E501
- Return type
- property model¶
Gets the model of this Incompressible. # noqa: E501
- Returns
The model of this Incompressible. # noqa: E501
- Return type
- property num_of_passive_species¶
Gets the num_of_passive_species of this Incompressible. # noqa: E501
Select the number of passive species involved in the simulation. Passive species allow you to simulate the transport of a scalar quantity within a fluid flow without affecting it. <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/#passive-species’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The num_of_passive_species of this Incompressible. # noqa: E501
- Return type
int
- property numerics¶
Gets the numerics of this Incompressible. # noqa: E501
- Returns
The numerics of this Incompressible. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'algorithm': 'str', 'boundary_conditions': 'list[OneOfIncompressibleBoundaryConditions]', 'enable_adjoint_optimization': 'bool', 'initial_conditions': 'FluidInitialConditions', 'materials': 'IncompressibleFluidMaterials', 'model': 'FluidModel', 'num_of_passive_species': 'int', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'time_dependency': 'OneOfIncompressibleTimeDependency', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this Incompressible. # noqa: E501
- Returns
The result_control of this Incompressible. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this Incompressible. # noqa: E501
- Returns
The simulation_control of this Incompressible. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this Incompressible. # noqa: E501
- Returns
The time_dependency of this Incompressible. # noqa: E501
- Return type
OneOfIncompressibleTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this Incompressible. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this Incompressible. # noqa: E501
- Return type
str
- property type¶
Gets the type of this Incompressible. # noqa: E501
Schema name: Incompressible # noqa: E501
- Returns
The type of this Incompressible. # noqa: E501
- Return type
str
simscale_sdk.models.incompressible_fluid_materials module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.incompressible_fluid_materials.IncompressibleFluidMaterials(fluids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fluids': 'fluids'}¶
- property fluids¶
Gets the fluids of this IncompressibleFluidMaterials. # noqa: E501
- Returns
The fluids of this IncompressibleFluidMaterials. # noqa: E501
- Return type
list[IncompressibleMaterial]
- openapi_types = {'fluids': 'list[IncompressibleMaterial]'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.incompressible_material module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.incompressible_material.IncompressibleMaterial(type='INCOMPRESSIBLE', name=None, associated_phase=None, viscosity_model=None, density=None, thermal_expansion_coefficient=None, reference_temperature=None, laminar_prandtl_number=None, turbulent_prandtl_number=None, specific_heat=None, molar_weight=None, cavitation=None, topological_reference=None, geometry_primitive_uuids=None, built_in_material=None, material_library_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property associated_phase¶
Gets the associated_phase of this IncompressibleMaterial. # noqa: E501
<p>Select the corresponding phase for this material:</p><p><b>Phase 0</b> would mean this material is represented by the phase fraction value of 0. Hence, a phase fraction of ‘0’ in your setup corresponds to 100% of this fluid material.</p><p><b>Phase 1</b> would mean this material is represented by the phase fraction value of 1. Hence, a phase fraction of ‘1’ in your setup corresponds to 100% of this fluid material.</p> # noqa: E501
- Returns
The associated_phase of this IncompressibleMaterial. # noqa: E501
- Return type
str
- attribute_map = {'associated_phase': 'associatedPhase', 'built_in_material': 'builtInMaterial', 'cavitation': 'cavitation', 'density': 'density', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'laminar_prandtl_number': 'laminarPrandtlNumber', 'material_library_reference': 'materialLibraryReference', 'molar_weight': 'molarWeight', 'name': 'name', 'reference_temperature': 'referenceTemperature', 'specific_heat': 'specificHeat', 'thermal_expansion_coefficient': 'thermalExpansionCoefficient', 'topological_reference': 'topologicalReference', 'turbulent_prandtl_number': 'turbulentPrandtlNumber', 'type': 'type', 'viscosity_model': 'viscosityModel'}¶
- property built_in_material¶
Gets the built_in_material of this IncompressibleMaterial. # noqa: E501
- Returns
The built_in_material of this IncompressibleMaterial. # noqa: E501
- Return type
str
- property cavitation¶
Gets the cavitation of this IncompressibleMaterial. # noqa: E501
- Returns
The cavitation of this IncompressibleMaterial. # noqa: E501
- Return type
- property density¶
Gets the density of this IncompressibleMaterial. # noqa: E501
- Returns
The density of this IncompressibleMaterial. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this IncompressibleMaterial. # noqa: E501
- Returns
The geometry_primitive_uuids of this IncompressibleMaterial. # noqa: E501
- Return type
list[str]
- property laminar_prandtl_number¶
Gets the laminar_prandtl_number of this IncompressibleMaterial. # noqa: E501
Laminar Prandtl number is used to calculate the heat transfer in the domain. # noqa: E501
- Returns
The laminar_prandtl_number of this IncompressibleMaterial. # noqa: E501
- Return type
float
- property material_library_reference¶
Gets the material_library_reference of this IncompressibleMaterial. # noqa: E501
- Returns
The material_library_reference of this IncompressibleMaterial. # noqa: E501
- Return type
- property molar_weight¶
Gets the molar_weight of this IncompressibleMaterial. # noqa: E501
- Returns
The molar_weight of this IncompressibleMaterial. # noqa: E501
- Return type
- property name¶
Gets the name of this IncompressibleMaterial. # noqa: E501
- Returns
The name of this IncompressibleMaterial. # noqa: E501
- Return type
str
- openapi_types = {'associated_phase': 'str', 'built_in_material': 'str', 'cavitation': 'Cavitation', 'density': 'DimensionalDensity', 'geometry_primitive_uuids': 'list[str]', 'laminar_prandtl_number': 'float', 'material_library_reference': 'MaterialLibraryReference', 'molar_weight': 'DimensionalMolarMass', 'name': 'str', 'reference_temperature': 'DimensionalTemperature', 'specific_heat': 'DimensionalSpecificHeat', 'thermal_expansion_coefficient': 'DimensionalThermalExpansionRate', 'topological_reference': 'TopologicalReference', 'turbulent_prandtl_number': 'float', 'type': 'str', 'viscosity_model': 'OneOfIncompressibleMaterialViscosityModel'}¶
- property reference_temperature¶
Gets the reference_temperature of this IncompressibleMaterial. # noqa: E501
- Returns
The reference_temperature of this IncompressibleMaterial. # noqa: E501
- Return type
- property specific_heat¶
Gets the specific_heat of this IncompressibleMaterial. # noqa: E501
- Returns
The specific_heat of this IncompressibleMaterial. # noqa: E501
- Return type
- property thermal_expansion_coefficient¶
Gets the thermal_expansion_coefficient of this IncompressibleMaterial. # noqa: E501
- Returns
The thermal_expansion_coefficient of this IncompressibleMaterial. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this IncompressibleMaterial. # noqa: E501
- Returns
The topological_reference of this IncompressibleMaterial. # noqa: E501
- Return type
- property turbulent_prandtl_number¶
Gets the turbulent_prandtl_number of this IncompressibleMaterial. # noqa: E501
Turbulent Prandtl number is used to calculate the heat transfer due to turbulent effects in the domain. # noqa: E501
- Returns
The turbulent_prandtl_number of this IncompressibleMaterial. # noqa: E501
- Return type
float
- property type¶
Gets the type of this IncompressibleMaterial. # noqa: E501
Schema name: IncompressibleMaterial # noqa: E501
- Returns
The type of this IncompressibleMaterial. # noqa: E501
- Return type
str
- property viscosity_model¶
Gets the viscosity_model of this IncompressibleMaterial. # noqa: E501
- Returns
The viscosity_model of this IncompressibleMaterial. # noqa: E501
- Return type
OneOfIncompressibleMaterialViscosityModel
simscale_sdk.models.incompressible_pacefish module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.incompressible_pacefish.IncompressiblePacefish(type='INCOMPRESSIBLE_PACEFISH', bounding_box_uuid=None, turbulence_model=None, material=None, flow_domain_boundaries=None, simulation_control=None, advanced_modelling=None, result_control=None, mesh_settings_new=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_modelling¶
Gets the advanced_modelling of this IncompressiblePacefish. # noqa: E501
- Returns
The advanced_modelling of this IncompressiblePacefish. # noqa: E501
- Return type
- attribute_map = {'advanced_modelling': 'advancedModelling', 'bounding_box_uuid': 'boundingBoxUuid', 'flow_domain_boundaries': 'flowDomainBoundaries', 'material': 'material', 'mesh_settings_new': 'meshSettingsNew', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property bounding_box_uuid¶
Gets the bounding_box_uuid of this IncompressiblePacefish. # noqa: E501
- Returns
The bounding_box_uuid of this IncompressiblePacefish. # noqa: E501
- Return type
str
- property flow_domain_boundaries¶
Gets the flow_domain_boundaries of this IncompressiblePacefish. # noqa: E501
- Returns
The flow_domain_boundaries of this IncompressiblePacefish. # noqa: E501
- Return type
- property material¶
Gets the material of this IncompressiblePacefish. # noqa: E501
- Returns
The material of this IncompressiblePacefish. # noqa: E501
- Return type
- property mesh_settings_new¶
Gets the mesh_settings_new of this IncompressiblePacefish. # noqa: E501
- Returns
The mesh_settings_new of this IncompressiblePacefish. # noqa: E501
- Return type
OneOfIncompressiblePacefishMeshSettingsNew
- openapi_types = {'advanced_modelling': 'AdvancedModelling', 'bounding_box_uuid': 'str', 'flow_domain_boundaries': 'FlowDomainBoundaries', 'material': 'IncompressibleMaterial', 'mesh_settings_new': 'OneOfIncompressiblePacefishMeshSettingsNew', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this IncompressiblePacefish. # noqa: E501
- Returns
The result_control of this IncompressiblePacefish. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this IncompressiblePacefish. # noqa: E501
- Returns
The simulation_control of this IncompressiblePacefish. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this IncompressiblePacefish. # noqa: E501
Choose between RANS, LES, or DES turbulence models. <a href=’https://www.simscale.com/docs/incompressible-lbm-lattice-boltzmann-advanced/#turbulence-models-in-incompressible-lbm’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The turbulence_model of this IncompressiblePacefish. # noqa: E501
- Return type
str
- property type¶
Gets the type of this IncompressiblePacefish. # noqa: E501
Schema name: IncompressiblePacefish # noqa: E501
- Returns
The type of this IncompressiblePacefish. # noqa: E501
- Return type
str
simscale_sdk.models.incompressible_perfect_gas_equation_of_state module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.incompressible_perfect_gas_equation_of_state.IncompressiblePerfectGasEquationOfState(type='INCOMPRESSIBLE_PERFECT_GAS', reference_pressure=None, energy=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'energy': 'energy', 'reference_pressure': 'referencePressure', 'type': 'type'}¶
- property energy¶
Gets the energy of this IncompressiblePerfectGasEquationOfState. # noqa: E501
<p><b>Energy</b> provides the methods for the form of energy to be used. The options are:</p><p><b>Sensible enthalpy:</b> The enthalpy form of equation is used without the heat of formation. In most cases this is the recommended choice.</p><p><b>Sensible internal Energy:</b> The internal energy form of equation is used without the heat of formation but also incorporates energy change due to reactions.</p> # noqa: E501
- Returns
The energy of this IncompressiblePerfectGasEquationOfState. # noqa: E501
- Return type
str
- openapi_types = {'energy': 'str', 'reference_pressure': 'DimensionalPressure', 'type': 'str'}¶
- property reference_pressure¶
Gets the reference_pressure of this IncompressiblePerfectGasEquationOfState. # noqa: E501
- Returns
The reference_pressure of this IncompressiblePerfectGasEquationOfState. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IncompressiblePerfectGasEquationOfState. # noqa: E501
<br><p>The <b>Equation of state</b> describes the relation between density of a fluid and the fluid pressure and temperature. The available options are:</p><p><b>Rho const:</b> Fluid density is assumed constant.</p><p><b>Incompressibel perfect gas:</b> The fluid is assumed to be an ‘Ideal Gas’ that is incompressible by pressure. But, fluid density can change due to temperature.</p><p><b>Perfect gas:</b> Fluid is assumed to be an ‘Ideal Gas’ and obeys the ‘Ideal Gas Law’.</p><p><b>Perfect fluid:</b> Fluid density can change due to pressure and temperature with respect to a base value.</p><p><b>Adiabatic perfect fluid:</b> The fluid is a perfect fluid which is adiabatic in nature.</p> <a href=’https://www.simscale.com/docs/simulation-setup/materials/thermophysical-fluid-models/#equation-of-state’ target=’_blank’>Learn more</a>. Schema name: IncompressiblePerfectGasEquationOfState # noqa: E501
- Returns
The type of this IncompressiblePerfectGasEquationOfState. # noqa: E501
- Return type
str
simscale_sdk.models.initial_timesteps_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.initial_timesteps_write_control.InitialTimestepsWriteControl(type='INITIAL', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InitialTimestepsWriteControl. # noqa: E501
<p>Define how frequently intermediate results should be saved. With the selection of <b>initial time steps</b> only the user defined time steps are stored in the result and by selecting <b>all computed time steps</b> also intermediate results that were created by the automatic time stepping are saved. With the selection of <b>write interval</b> a specific write frequency can be chosen which reduces the result size. Finally using <b>user defined time steps</b> there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the <b>time step length</b> definition.</p> Schema name: InitialTimestepsWriteControl # noqa: E501
- Returns
The type of this InitialTimestepsWriteControl. # noqa: E501
- Return type
str
simscale_sdk.models.inlet_outlet_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_dvbc.InletOutletDVBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletDVBC. # noqa: E501
Schema name: InletOutletDVBC # noqa: E501
- Returns
The type of this InletOutletDVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletDVBC. # noqa: E501
- Returns
The value of this InletOutletDVBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_ebc.InletOutletEBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalTurbulentDissipation'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletEBC. # noqa: E501
Schema name: InletOutletEBC # noqa: E501
- Returns
The type of this InletOutletEBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletEBC. # noqa: E501
- Returns
The value of this InletOutletEBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_evbc.InletOutletEVBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletEVBC. # noqa: E501
Schema name: InletOutletEVBC # noqa: E501
- Returns
The type of this InletOutletEVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletEVBC. # noqa: E501
- Returns
The value of this InletOutletEVBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_evcbc.InletOutletEVCBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDynamicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletEVCBC. # noqa: E501
Schema name: InletOutletEVCBC # noqa: E501
- Returns
The type of this InletOutletEVCBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletEVCBC. # noqa: E501
- Returns
The value of this InletOutletEVCBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_nbc.InletOutletNBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalKinematicViscosity'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletNBC. # noqa: E501
Schema name: InletOutletNBC # noqa: E501
- Returns
The type of this InletOutletNBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletNBC. # noqa: E501
- Returns
The value of this InletOutletNBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_obc.InletOutletOBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalSpecificTurbulenceDissipationRate'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletOBC. # noqa: E501
Schema name: InletOutletOBC # noqa: E501
- Returns
The type of this InletOutletOBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletOBC. # noqa: E501
- Returns
The value of this InletOutletOBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_pfbc.InletOutletPFBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDimensionless'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletPFBC. # noqa: E501
Schema name: InletOutletPFBC # noqa: E501
- Returns
The type of this InletOutletPFBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletPFBC. # noqa: E501
- Returns
The value of this InletOutletPFBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_psbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_psbc.InletOutletPSBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalDimensionless'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletPSBC. # noqa: E501
Schema name: InletOutletPSBC # noqa: E501
- Returns
The type of this InletOutletPSBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletPSBC. # noqa: E501
- Returns
The value of this InletOutletPSBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_tbc.InletOutletTBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalTemperature'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletTBC. # noqa: E501
Schema name: InletOutletTBC # noqa: E501
- Returns
The type of this InletOutletTBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletTBC. # noqa: E501
- Returns
The value of this InletOutletTBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_tkebc.InletOutletTKEBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalTurbulenceKineticEnergy'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletTKEBC. # noqa: E501
Schema name: InletOutletTKEBC # noqa: E501
- Returns
The type of this InletOutletTKEBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletTKEBC. # noqa: E501
- Returns
The value of this InletOutletTKEBC. # noqa: E501
- Return type
simscale_sdk.models.inlet_outlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inlet_outlet_vbc.InletOutletVBC(type='INLET_OUTLET', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalVectorSpeed'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InletOutletVBC. # noqa: E501
Schema name: InletOutletVBC # noqa: E501
- Returns
The type of this InletOutletVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InletOutletVBC. # noqa: E501
- Returns
The value of this InletOutletVBC. # noqa: E501
- Return type
simscale_sdk.models.inside_region_refinement_with_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inside_region_refinement_with_length.InsideRegionRefinementWithLength(type='INSIDE', length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'length': 'length', 'type': 'type'}¶
- property length¶
Gets the length of this InsideRegionRefinementWithLength. # noqa: E501
- Returns
The length of this InsideRegionRefinementWithLength. # noqa: E501
- Return type
- openapi_types = {'length': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InsideRegionRefinementWithLength. # noqa: E501
Schema name: InsideRegionRefinementWithLength # noqa: E501
- Returns
The type of this InsideRegionRefinementWithLength. # noqa: E501
- Return type
str
simscale_sdk.models.inside_region_refinement_with_levels module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.inside_region_refinement_with_levels.InsideRegionRefinementWithLevels(type='INSIDE', level=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'level': 'level', 'type': 'type'}¶
- property level¶
Gets the level of this InsideRegionRefinementWithLevels. # noqa: E501
- Returns
The level of this InsideRegionRefinementWithLevels. # noqa: E501
- Return type
int
- openapi_types = {'level': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InsideRegionRefinementWithLevels. # noqa: E501
Schema name: InsideRegionRefinementWithLevels # noqa: E501
- Returns
The type of this InsideRegionRefinementWithLevels. # noqa: E501
- Return type
str
simscale_sdk.models.intensity_kinetic_energy_inlet_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.intensity_kinetic_energy_inlet_tkebc.IntensityKineticEnergyInletTKEBC(type='TURBULENT_INTENSITY_KINETIC_ENERGY_INLET', intensity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'intensity': 'intensity', 'type': 'type'}¶
- property intensity¶
Gets the intensity of this IntensityKineticEnergyInletTKEBC. # noqa: E501
- Returns
The intensity of this IntensityKineticEnergyInletTKEBC. # noqa: E501
- Return type
float
- openapi_types = {'intensity': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IntensityKineticEnergyInletTKEBC. # noqa: E501
Schema name: IntensityKineticEnergyInletTKEBC # noqa: E501
- Returns
The type of this IntensityKineticEnergyInletTKEBC. # noqa: E501
- Return type
str
simscale_sdk.models.intern_variables_field module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.intern_variables_field.InternVariablesField(type='INTERN_VARIABLES', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this InternVariablesField. # noqa: E501
<p>Choose a field component for which the data schould be extracted.</p> # noqa: E501
- Returns
The component_selection of this InternVariablesField. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this InternVariablesField. # noqa: E501
<p>Select the field which should have a limited de-/increase within one increment.</p> Schema name: InternVariablesField # noqa: E501
- Returns
The type of this InternVariablesField. # noqa: E501
- Return type
str
simscale_sdk.models.interpolation_parameter module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.interpolation_parameter.InterpolationParameter(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this InterpolationParameter. # noqa: E501
- Returns
The unit of this InterpolationParameter. # noqa: E501
- Return type
str
- property value¶
Gets the value of this InterpolationParameter. # noqa: E501
- Returns
The value of this InterpolationParameter. # noqa: E501
- Return type
float
simscale_sdk.models.interpolation_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.interpolation_schemes.InterpolationSchemes(for_default=None, interpolate_hby_a=None, interpolate_velocity=None, interpolate_kappa=None, interpolate_rho=None, interpolate_thermo_rho_cp=None, interpolate_map_kappa=None, interpolate_rho_hbya=None, interpolate_rho_0_velocity0=None, interpolate_grad_enthalpy=None, interpolate_rho_r_au=None, interpolate_r_au=None, interpolate_velocity0=None, reconstruct_velocity=None, reconstruct_temperature=None, reconstruct_rho=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'for_default': 'forDefault', 'interpolate_grad_enthalpy': 'interpolate_grad_enthalpy', 'interpolate_hby_a': 'interpolate_HbyA', 'interpolate_kappa': 'interpolate_kappa', 'interpolate_map_kappa': 'interpolate_map_Kappa', 'interpolate_r_au': 'interpolate_rAU', 'interpolate_rho': 'interpolate_rho', 'interpolate_rho_0_velocity0': 'interpolate_rho_0_velocity0', 'interpolate_rho_hbya': 'interpolate_rho_Hbya', 'interpolate_rho_r_au': 'interpolate_rho_rAU', 'interpolate_thermo_rho_cp': 'interpolate_thermo_rho_Cp', 'interpolate_velocity': 'interpolate_velocity', 'interpolate_velocity0': 'interpolate_velocity0', 'reconstruct_rho': 'reconstruct_rho', 'reconstruct_temperature': 'reconstruct_temperature', 'reconstruct_velocity': 'reconstruct_velocity'}¶
- property for_default¶
Gets the for_default of this InterpolationSchemes. # noqa: E501
- Returns
The for_default of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesForDefault
- property interpolate_grad_enthalpy¶
Gets the interpolate_grad_enthalpy of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_grad_enthalpy of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateGradEnthalpy
- property interpolate_hby_a¶
Gets the interpolate_hby_a of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_hby_a of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateHbyA
- property interpolate_kappa¶
Gets the interpolate_kappa of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_kappa of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateKappa
- property interpolate_map_kappa¶
Gets the interpolate_map_kappa of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_map_kappa of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateMapKappa
- property interpolate_r_au¶
Gets the interpolate_r_au of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_r_au of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateRAU
- property interpolate_rho¶
Gets the interpolate_rho of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_rho of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateRho
- property interpolate_rho_0_velocity0¶
Gets the interpolate_rho_0_velocity0 of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_rho_0_velocity0 of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateRho0Velocity0
- property interpolate_rho_hbya¶
Gets the interpolate_rho_hbya of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_rho_hbya of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateRhoHbya
- property interpolate_rho_r_au¶
Gets the interpolate_rho_r_au of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_rho_r_au of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateRhoRAU
- property interpolate_thermo_rho_cp¶
Gets the interpolate_thermo_rho_cp of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_thermo_rho_cp of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateThermoRhoCp
- property interpolate_velocity¶
Gets the interpolate_velocity of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_velocity of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateVelocity
- property interpolate_velocity0¶
Gets the interpolate_velocity0 of this InterpolationSchemes. # noqa: E501
- Returns
The interpolate_velocity0 of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesInterpolateVelocity0
- openapi_types = {'for_default': 'OneOfInterpolationSchemesForDefault', 'interpolate_grad_enthalpy': 'OneOfInterpolationSchemesInterpolateGradEnthalpy', 'interpolate_hby_a': 'OneOfInterpolationSchemesInterpolateHbyA', 'interpolate_kappa': 'OneOfInterpolationSchemesInterpolateKappa', 'interpolate_map_kappa': 'OneOfInterpolationSchemesInterpolateMapKappa', 'interpolate_r_au': 'OneOfInterpolationSchemesInterpolateRAU', 'interpolate_rho': 'OneOfInterpolationSchemesInterpolateRho', 'interpolate_rho_0_velocity0': 'OneOfInterpolationSchemesInterpolateRho0Velocity0', 'interpolate_rho_hbya': 'OneOfInterpolationSchemesInterpolateRhoHbya', 'interpolate_rho_r_au': 'OneOfInterpolationSchemesInterpolateRhoRAU', 'interpolate_thermo_rho_cp': 'OneOfInterpolationSchemesInterpolateThermoRhoCp', 'interpolate_velocity': 'OneOfInterpolationSchemesInterpolateVelocity', 'interpolate_velocity0': 'OneOfInterpolationSchemesInterpolateVelocity0', 'reconstruct_rho': 'OneOfInterpolationSchemesReconstructRho', 'reconstruct_temperature': 'OneOfInterpolationSchemesReconstructTemperature', 'reconstruct_velocity': 'OneOfInterpolationSchemesReconstructVelocity'}¶
- property reconstruct_rho¶
Gets the reconstruct_rho of this InterpolationSchemes. # noqa: E501
- Returns
The reconstruct_rho of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesReconstructRho
- property reconstruct_temperature¶
Gets the reconstruct_temperature of this InterpolationSchemes. # noqa: E501
- Returns
The reconstruct_temperature of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesReconstructTemperature
- property reconstruct_velocity¶
Gets the reconstruct_velocity of this InterpolationSchemes. # noqa: E501
- Returns
The reconstruct_velocity of this InterpolationSchemes. # noqa: E501
- Return type
OneOfInterpolationSchemesReconstructVelocity
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.iram_sorensen module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.iram_sorensen.IRAMSorensen(type='SORENSEN', prec_soren=None, nmax_iter_soren=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'nmax_iter_soren': 'nmaxIterSoren', 'prec_soren': 'precSoren', 'type': 'type'}¶
- property nmax_iter_soren¶
Gets the nmax_iter_soren of this IRAMSorensen. # noqa: E501
- Returns
The nmax_iter_soren of this IRAMSorensen. # noqa: E501
- Return type
int
- openapi_types = {'nmax_iter_soren': 'int', 'prec_soren': 'float', 'type': 'str'}¶
- property prec_soren¶
Gets the prec_soren of this IRAMSorensen. # noqa: E501
- Returns
The prec_soren of this IRAMSorensen. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IRAMSorensen. # noqa: E501
Schema name: IRAMSorensen # noqa: E501
- Returns
The type of this IRAMSorensen. # noqa: E501
- Return type
str
simscale_sdk.models.iso_surface module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.iso_surface.IsoSurface(iso_scalar=None, iso_value=None, scalar_field=None, solid_color=None, vector_field=None, opacity=1.0, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iso_scalar': 'isoScalar', 'iso_value': 'isoValue', 'opacity': 'opacity', 'scalar_field': 'scalarField', 'solid_color': 'solidColor', 'vector_field': 'vectorField'}¶
- property iso_scalar¶
Gets the iso_scalar of this IsoSurface. # noqa: E501
- Returns
The iso_scalar of this IsoSurface. # noqa: E501
- Return type
- property iso_value¶
Gets the iso_value of this IsoSurface. # noqa: E501
The iso scalar value. Should be within the selected scalar range. Default value is the average between the min and max in the range. # noqa: E501
- Returns
The iso_value of this IsoSurface. # noqa: E501
- Return type
float
- property opacity¶
Gets the opacity of this IsoSurface. # noqa: E501
- Returns
The opacity of this IsoSurface. # noqa: E501
- Return type
float
- openapi_types = {'iso_scalar': 'ScalarField', 'iso_value': 'float', 'opacity': 'float', 'scalar_field': 'ScalarField', 'solid_color': 'Color', 'vector_field': 'VectorField'}¶
- property scalar_field¶
Gets the scalar_field of this IsoSurface. # noqa: E501
- Returns
The scalar_field of this IsoSurface. # noqa: E501
- Return type
- property solid_color¶
Gets the solid_color of this IsoSurface. # noqa: E501
- Returns
The solid_color of this IsoSurface. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vector_field¶
Gets the vector_field of this IsoSurface. # noqa: E501
- Returns
The vector_field of this IsoSurface. # noqa: E501
- Return type
simscale_sdk.models.iso_volume module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.iso_volume.IsoVolume(iso_scalar=None, minimum_iso_value=None, maximum_iso_value=None, scalar_field=None, solid_color=None, vector_field=None, opacity=1.0, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iso_scalar': 'isoScalar', 'maximum_iso_value': 'maximumIsoValue', 'minimum_iso_value': 'minimumIsoValue', 'opacity': 'opacity', 'scalar_field': 'scalarField', 'solid_color': 'solidColor', 'vector_field': 'vectorField'}¶
- property iso_scalar¶
Gets the iso_scalar of this IsoVolume. # noqa: E501
- Returns
The iso_scalar of this IsoVolume. # noqa: E501
- Return type
- property maximum_iso_value¶
Gets the maximum_iso_value of this IsoVolume. # noqa: E501
The iso scalar maximum value. Should be within the selected scalar range and larger than the minimumIsoValue. Default value is 2 thirds of the range between min and max. # noqa: E501
- Returns
The maximum_iso_value of this IsoVolume. # noqa: E501
- Return type
float
- property minimum_iso_value¶
Gets the minimum_iso_value of this IsoVolume. # noqa: E501
The iso scalar minimum value. Should be within the selected scalar range and smaller than the maximumIsoValue. Default value is the third of the range between min and max. # noqa: E501
- Returns
The minimum_iso_value of this IsoVolume. # noqa: E501
- Return type
float
- property opacity¶
Gets the opacity of this IsoVolume. # noqa: E501
- Returns
The opacity of this IsoVolume. # noqa: E501
- Return type
float
- openapi_types = {'iso_scalar': 'ScalarField', 'maximum_iso_value': 'float', 'minimum_iso_value': 'float', 'opacity': 'float', 'scalar_field': 'ScalarField', 'solid_color': 'Color', 'vector_field': 'VectorField'}¶
- property scalar_field¶
Gets the scalar_field of this IsoVolume. # noqa: E501
- Returns
The scalar_field of this IsoVolume. # noqa: E501
- Return type
- property solid_color¶
Gets the solid_color of this IsoVolume. # noqa: E501
- Returns
The solid_color of this IsoVolume. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vector_field¶
Gets the vector_field of this IsoVolume. # noqa: E501
- Returns
The vector_field of this IsoVolume. # noqa: E501
- Return type
simscale_sdk.models.isotropic_conductivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.isotropic_conductivity.IsotropicConductivity(type='ISOTROPIC', thermal_conductivity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'thermal_conductivity': 'thermalConductivity', 'type': 'type'}¶
- openapi_types = {'thermal_conductivity': 'DimensionalFunctionThermalConductivity', 'type': 'str'}¶
- property thermal_conductivity¶
Gets the thermal_conductivity of this IsotropicConductivity. # noqa: E501
- Returns
The thermal_conductivity of this IsotropicConductivity. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IsotropicConductivity. # noqa: E501
<p>Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.</p> Schema name: IsotropicConductivity # noqa: E501
- Returns
The type of this IsotropicConductivity. # noqa: E501
- Return type
str
simscale_sdk.models.isotropic_darcy_forchheimer module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.isotropic_darcy_forchheimer.IsotropicDarcyForchheimer(type='ISOTROPIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IsotropicDarcyForchheimer. # noqa: E501
Isotropic porous object where the same permeability and friction form coefficient are applied in all directions. Schema name: IsotropicDarcyForchheimer # noqa: E501
- Returns
The type of this IsotropicDarcyForchheimer. # noqa: E501
- Return type
str
simscale_sdk.models.isotropic_directional_dependency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.isotropic_directional_dependency.IsotropicDirectionalDependency(type='ISOTROPIC', youngs_modulus=None, poissons_ratio=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'poissons_ratio': 'poissonsRatio', 'type': 'type', 'youngs_modulus': 'youngsModulus'}¶
- openapi_types = {'poissons_ratio': 'OneOfIsotropicDirectionalDependencyPoissonsRatio', 'type': 'str', 'youngs_modulus': 'DimensionalFunctionPressure'}¶
- property poissons_ratio¶
Gets the poissons_ratio of this IsotropicDirectionalDependency. # noqa: E501
- Returns
The poissons_ratio of this IsotropicDirectionalDependency. # noqa: E501
- Return type
OneOfIsotropicDirectionalDependencyPoissonsRatio
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IsotropicDirectionalDependency. # noqa: E501
<p>Choose the directional dependency for this property. <b>Anisotropic and orthotropic materials will be available soon.</b></p> Schema name: IsotropicDirectionalDependency # noqa: E501
- Returns
The type of this IsotropicDirectionalDependency. # noqa: E501
- Return type
str
- property youngs_modulus¶
Gets the youngs_modulus of this IsotropicDirectionalDependency. # noqa: E501
- Returns
The youngs_modulus of this IsotropicDirectionalDependency. # noqa: E501
- Return type
simscale_sdk.models.isotropic_expansion module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.isotropic_expansion.IsotropicExpansion(type='ISOTROPIC', expansion_coefficient=None, reference_temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'expansion_coefficient': 'expansionCoefficient', 'reference_temperature': 'referenceTemperature', 'type': 'type'}¶
- property expansion_coefficient¶
Gets the expansion_coefficient of this IsotropicExpansion. # noqa: E501
- Returns
The expansion_coefficient of this IsotropicExpansion. # noqa: E501
- Return type
- openapi_types = {'expansion_coefficient': 'DimensionalFunctionThermalExpansionRate', 'reference_temperature': 'DimensionalTemperature', 'type': 'str'}¶
- property reference_temperature¶
Gets the reference_temperature of this IsotropicExpansion. # noqa: E501
- Returns
The reference_temperature of this IsotropicExpansion. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IsotropicExpansion. # noqa: E501
<p>Define the directional dependency of this property. Isotropic means directionally independent.</p> Schema name: IsotropicExpansion # noqa: E501
- Returns
The type of this IsotropicExpansion. # noqa: E501
- Return type
str
simscale_sdk.models.isotropic_plastic_hardening module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.isotropic_plastic_hardening.IsotropicPlasticHardening(type='ISOTROPIC', youngs_modulus=None, poissons_ratio=None, von_mises_stress=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'poissons_ratio': 'poissonsRatio', 'type': 'type', 'von_mises_stress': 'vonMisesStress', 'youngs_modulus': 'youngsModulus'}¶
- openapi_types = {'poissons_ratio': 'OneOfIsotropicPlasticHardeningPoissonsRatio', 'type': 'str', 'von_mises_stress': 'DimensionalFunctionPressure', 'youngs_modulus': 'DimensionalFunctionPressure'}¶
- property poissons_ratio¶
Gets the poissons_ratio of this IsotropicPlasticHardening. # noqa: E501
- Returns
The poissons_ratio of this IsotropicPlasticHardening. # noqa: E501
- Return type
OneOfIsotropicPlasticHardeningPoissonsRatio
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IsotropicPlasticHardening. # noqa: E501
<p>Define the plastic hardening type of the material.</p> Schema name: IsotropicPlasticHardening # noqa: E501
- Returns
The type of this IsotropicPlasticHardening. # noqa: E501
- Return type
str
- property von_mises_stress¶
Gets the von_mises_stress of this IsotropicPlasticHardening. # noqa: E501
- Returns
The von_mises_stress of this IsotropicPlasticHardening. # noqa: E501
- Return type
- property youngs_modulus¶
Gets the youngs_modulus of this IsotropicPlasticHardening. # noqa: E501
- Returns
The youngs_modulus of this IsotropicPlasticHardening. # noqa: E501
- Return type
simscale_sdk.models.isotropic_spring_stiffness module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.isotropic_spring_stiffness.IsotropicSpringStiffness(type='ISOTROPIC', stiffness_definition=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'stiffness_definition': 'stiffnessDefinition', 'type': 'type'}¶
- openapi_types = {'stiffness_definition': 'OneOfIsotropicSpringStiffnessStiffnessDefinition', 'type': 'str'}¶
- property stiffness_definition¶
Gets the stiffness_definition of this IsotropicSpringStiffness. # noqa: E501
- Returns
The stiffness_definition of this IsotropicSpringStiffness. # noqa: E501
- Return type
OneOfIsotropicSpringStiffnessStiffnessDefinition
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this IsotropicSpringStiffness. # noqa: E501
Schema name: IsotropicSpringStiffness # noqa: E501
- Returns
The type of this IsotropicSpringStiffness. # noqa: E501
- Return type
str
simscale_sdk.models.jacobi_preconditioner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.jacobi_preconditioner.JacobiPreconditioner(type='JACOBI', renumbering_method=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'renumbering_method': 'renumberingMethod', 'type': 'type'}¶
- openapi_types = {'renumbering_method': 'str', 'type': 'str'}¶
- property renumbering_method¶
Gets the renumbering_method of this JacobiPreconditioner. # noqa: E501
Choose the renumbering method for the system matrix entries:<ul><li><p><b>RCMK</b> uses the algorithm of <i>Reverse Cuthill-MacKee</i> for the renumbering. It often effectively reduces the matrig storage space and the matrix factorization time.</p></ul><ul><li><p>When <b>inactive</b> is selected no renumbering is done. This option should only be chosen for testing purposes.</p></ul> # noqa: E501
- Returns
The renumbering_method of this JacobiPreconditioner. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this JacobiPreconditioner. # noqa: E501
Schema name: JacobiPreconditioner # noqa: E501
- Returns
The type of this JacobiPreconditioner. # noqa: E501
- Return type
str
simscale_sdk.models.kurganov_flux_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.kurganov_flux_scheme.KurganovFluxScheme(type='KURGANOV', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this KurganovFluxScheme. # noqa: E501
Schema name: KurganovFluxScheme # noqa: E501
- Returns
The type of this KurganovFluxScheme. # noqa: E501
- Return type
str
simscale_sdk.models.lanczos module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.lanczos.Lanczos(type='TRI_DIAG', prec_ortho=None, nmax_iter_ortho=None, prec_lanczos=None, max_iter_qr=None, mode_rigid=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_iter_qr': 'maxIterQR', 'mode_rigid': 'modeRigid', 'nmax_iter_ortho': 'nmaxIterOrtho', 'prec_lanczos': 'precLanczos', 'prec_ortho': 'precOrtho', 'type': 'type'}¶
- property max_iter_qr¶
Gets the max_iter_qr of this Lanczos. # noqa: E501
- Returns
The max_iter_qr of this Lanczos. # noqa: E501
- Return type
int
- property mode_rigid¶
Gets the mode_rigid of this Lanczos. # noqa: E501
- Returns
The mode_rigid of this Lanczos. # noqa: E501
- Return type
bool
- property nmax_iter_ortho¶
Gets the nmax_iter_ortho of this Lanczos. # noqa: E501
- Returns
The nmax_iter_ortho of this Lanczos. # noqa: E501
- Return type
int
- openapi_types = {'max_iter_qr': 'int', 'mode_rigid': 'bool', 'nmax_iter_ortho': 'int', 'prec_lanczos': 'float', 'prec_ortho': 'float', 'type': 'str'}¶
- property prec_lanczos¶
Gets the prec_lanczos of this Lanczos. # noqa: E501
- Returns
The prec_lanczos of this Lanczos. # noqa: E501
- Return type
float
- property prec_ortho¶
Gets the prec_ortho of this Lanczos. # noqa: E501
- Returns
The prec_ortho of this Lanczos. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Lanczos. # noqa: E501
Schema name: Lanczos # noqa: E501
- Returns
The type of this Lanczos. # noqa: E501
- Return type
str
simscale_sdk.models.laplacian_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.laplacian_schemes.LaplacianSchemes(for_default=None, laplacian_nu_eff_velocity=None, laplacian_1_a_u_pressure=None, laplacian_nu_velocity=None, laplacian_dr_eff_r=None, laplacian_dnu_tilda_eff_nu_tilda=None, laplacian_dk_eff_turbulent_kinetic_energy=None, laplacian_alpha_eff_enthalpy=None, laplacian_alpha_enthalpy=None, laplacian_mu_eff_velocity=None, laplacian_alpha_eff_internal_energy=None, laplacian_rhor_a_uf_pressure_rgh=None, laplacian_depsilon_eff_epsilon_dissipation_rate=None, laplacian_domega_eff_omega_dissipation_rate=None, laplacian_r_a_uf_pressure=None, laplacian_dt_passive_scalar=None, laplacian_dp_pressure=None, laplacian_rhor_a_uf_pressure=None, laplacian_rho_1_a_u_pressure=None, laplacian_mut_velocity=None, laplacian_alpha_eff_temperature=None, laplacian_r_a_uf_pressure_rgh=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'for_default': 'forDefault', 'laplacian_1_a_u_pressure': 'laplacian_1A_U_pressure', 'laplacian_alpha_eff_enthalpy': 'laplacian_alphaEff_enthalpy', 'laplacian_alpha_eff_internal_energy': 'laplacian_alphaEff_internalEnergy', 'laplacian_alpha_eff_temperature': 'laplacian_alphaEff_temperature', 'laplacian_alpha_enthalpy': 'laplacian_alpha_enthalpy', 'laplacian_depsilon_eff_epsilon_dissipation_rate': 'laplacian_DepsilonEff_epsilonDissipationRate', 'laplacian_dk_eff_turbulent_kinetic_energy': 'laplacian_DkEff_turbulentKineticEnergy', 'laplacian_dnu_tilda_eff_nu_tilda': 'laplacian_DnuTildaEff_nuTilda', 'laplacian_domega_eff_omega_dissipation_rate': 'laplacian_DomegaEff_omegaDissipationRate', 'laplacian_dp_pressure': 'laplacian_Dp_pressure', 'laplacian_dr_eff_r': 'laplacian_DREff_R', 'laplacian_dt_passive_scalar': 'laplacian_DT_passiveScalar', 'laplacian_mu_eff_velocity': 'laplacian_muEff_velocity', 'laplacian_mut_velocity': 'laplacian_mut_velocity', 'laplacian_nu_eff_velocity': 'laplacian_NuEff_velocity', 'laplacian_nu_velocity': 'laplacian_Nu_velocity', 'laplacian_r_a_uf_pressure': 'laplacian_rAUf_pressure', 'laplacian_r_a_uf_pressure_rgh': 'laplacian_rAUf_pressureRgh', 'laplacian_rho_1_a_u_pressure': 'laplacian_rho_1_A_U_pressure', 'laplacian_rhor_a_uf_pressure': 'laplacian_rhorAUf_pressure', 'laplacian_rhor_a_uf_pressure_rgh': 'laplacian_rhorAUf_pressureRgh'}¶
- property for_default¶
Gets the for_default of this LaplacianSchemes. # noqa: E501
- Returns
The for_default of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesForDefault
- property laplacian_1_a_u_pressure¶
Gets the laplacian_1_a_u_pressure of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_1_a_u_pressure of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacian1AUPressure
- property laplacian_alpha_eff_enthalpy¶
Gets the laplacian_alpha_eff_enthalpy of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_alpha_eff_enthalpy of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianAlphaEffEnthalpy
- property laplacian_alpha_eff_internal_energy¶
Gets the laplacian_alpha_eff_internal_energy of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_alpha_eff_internal_energy of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianAlphaEffInternalEnergy
- property laplacian_alpha_eff_temperature¶
Gets the laplacian_alpha_eff_temperature of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_alpha_eff_temperature of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianAlphaEffTemperature
- property laplacian_alpha_enthalpy¶
Gets the laplacian_alpha_enthalpy of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_alpha_enthalpy of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianAlphaEnthalpy
- property laplacian_depsilon_eff_epsilon_dissipation_rate¶
Gets the laplacian_depsilon_eff_epsilon_dissipation_rate of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_depsilon_eff_epsilon_dissipation_rate of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDepsilonEffEpsilonDissipationRate
- property laplacian_dk_eff_turbulent_kinetic_energy¶
Gets the laplacian_dk_eff_turbulent_kinetic_energy of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_dk_eff_turbulent_kinetic_energy of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDkEffTurbulentKineticEnergy
- property laplacian_dnu_tilda_eff_nu_tilda¶
Gets the laplacian_dnu_tilda_eff_nu_tilda of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_dnu_tilda_eff_nu_tilda of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDnuTildaEffNuTilda
- property laplacian_domega_eff_omega_dissipation_rate¶
Gets the laplacian_domega_eff_omega_dissipation_rate of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_domega_eff_omega_dissipation_rate of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDomegaEffOmegaDissipationRate
- property laplacian_dp_pressure¶
Gets the laplacian_dp_pressure of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_dp_pressure of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDpPressure
- property laplacian_dr_eff_r¶
Gets the laplacian_dr_eff_r of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_dr_eff_r of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDREffR
- property laplacian_dt_passive_scalar¶
Gets the laplacian_dt_passive_scalar of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_dt_passive_scalar of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianDTPassiveScalar
- property laplacian_mu_eff_velocity¶
Gets the laplacian_mu_eff_velocity of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_mu_eff_velocity of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianMuEffVelocity
- property laplacian_mut_velocity¶
Gets the laplacian_mut_velocity of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_mut_velocity of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianMutVelocity
- property laplacian_nu_eff_velocity¶
Gets the laplacian_nu_eff_velocity of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_nu_eff_velocity of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianNuEffVelocity
- property laplacian_nu_velocity¶
Gets the laplacian_nu_velocity of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_nu_velocity of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianNuVelocity
- property laplacian_r_a_uf_pressure¶
Gets the laplacian_r_a_uf_pressure of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_r_a_uf_pressure of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianRAUfPressure
- property laplacian_r_a_uf_pressure_rgh¶
Gets the laplacian_r_a_uf_pressure_rgh of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_r_a_uf_pressure_rgh of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianRAUfPressureRgh
- property laplacian_rho_1_a_u_pressure¶
Gets the laplacian_rho_1_a_u_pressure of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_rho_1_a_u_pressure of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianRho1AUPressure
- property laplacian_rhor_a_uf_pressure¶
Gets the laplacian_rhor_a_uf_pressure of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_rhor_a_uf_pressure of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianRhorAUfPressure
- property laplacian_rhor_a_uf_pressure_rgh¶
Gets the laplacian_rhor_a_uf_pressure_rgh of this LaplacianSchemes. # noqa: E501
- Returns
The laplacian_rhor_a_uf_pressure_rgh of this LaplacianSchemes. # noqa: E501
- Return type
OneOfLaplacianSchemesLaplacianRhorAUfPressureRgh
- openapi_types = {'for_default': 'OneOfLaplacianSchemesForDefault', 'laplacian_1_a_u_pressure': 'OneOfLaplacianSchemesLaplacian1AUPressure', 'laplacian_alpha_eff_enthalpy': 'OneOfLaplacianSchemesLaplacianAlphaEffEnthalpy', 'laplacian_alpha_eff_internal_energy': 'OneOfLaplacianSchemesLaplacianAlphaEffInternalEnergy', 'laplacian_alpha_eff_temperature': 'OneOfLaplacianSchemesLaplacianAlphaEffTemperature', 'laplacian_alpha_enthalpy': 'OneOfLaplacianSchemesLaplacianAlphaEnthalpy', 'laplacian_depsilon_eff_epsilon_dissipation_rate': 'OneOfLaplacianSchemesLaplacianDepsilonEffEpsilonDissipationRate', 'laplacian_dk_eff_turbulent_kinetic_energy': 'OneOfLaplacianSchemesLaplacianDkEffTurbulentKineticEnergy', 'laplacian_dnu_tilda_eff_nu_tilda': 'OneOfLaplacianSchemesLaplacianDnuTildaEffNuTilda', 'laplacian_domega_eff_omega_dissipation_rate': 'OneOfLaplacianSchemesLaplacianDomegaEffOmegaDissipationRate', 'laplacian_dp_pressure': 'OneOfLaplacianSchemesLaplacianDpPressure', 'laplacian_dr_eff_r': 'OneOfLaplacianSchemesLaplacianDREffR', 'laplacian_dt_passive_scalar': 'OneOfLaplacianSchemesLaplacianDTPassiveScalar', 'laplacian_mu_eff_velocity': 'OneOfLaplacianSchemesLaplacianMuEffVelocity', 'laplacian_mut_velocity': 'OneOfLaplacianSchemesLaplacianMutVelocity', 'laplacian_nu_eff_velocity': 'OneOfLaplacianSchemesLaplacianNuEffVelocity', 'laplacian_nu_velocity': 'OneOfLaplacianSchemesLaplacianNuVelocity', 'laplacian_r_a_uf_pressure': 'OneOfLaplacianSchemesLaplacianRAUfPressure', 'laplacian_r_a_uf_pressure_rgh': 'OneOfLaplacianSchemesLaplacianRAUfPressureRgh', 'laplacian_rho_1_a_u_pressure': 'OneOfLaplacianSchemesLaplacianRho1AUPressure', 'laplacian_rhor_a_uf_pressure': 'OneOfLaplacianSchemesLaplacianRhorAUfPressure', 'laplacian_rhor_a_uf_pressure_rgh': 'OneOfLaplacianSchemesLaplacianRhorAUfPressureRgh'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.layer_adding_controls module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.layer_adding_controls.LayerAddingControls(relative_size=None, max_cancelled_layers_near_sharp_features=None, feature_angle=None, slip_feature_angle=None, relax_iterations=None, surface_normals_max_smoothing_iterations=None, internal_mesh_max_smoothing_iterations=None, layer_thickness_max_smoothing_iterations=None, max_face_thickness_ratio=None, max_thickness_to_medial_ratio=None, min_median_axis_angle=None, buffer_cells_no_extrude=None, layer_addition_max_iterations=None, max_iterations_with_strict_quality_controls=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'buffer_cells_no_extrude': 'bufferCellsNoExtrude', 'feature_angle': 'featureAngle', 'internal_mesh_max_smoothing_iterations': 'internalMeshMaxSmoothingIterations', 'layer_addition_max_iterations': 'layerAdditionMaxIterations', 'layer_thickness_max_smoothing_iterations': 'layerThicknessMaxSmoothingIterations', 'max_cancelled_layers_near_sharp_features': 'maxCancelledLayersNearSharpFeatures', 'max_face_thickness_ratio': 'maxFaceThicknessRatio', 'max_iterations_with_strict_quality_controls': 'maxIterationsWithStrictQualityControls', 'max_thickness_to_medial_ratio': 'maxThicknessToMedialRatio', 'min_median_axis_angle': 'minMedianAxisAngle', 'relative_size': 'relativeSize', 'relax_iterations': 'relaxIterations', 'slip_feature_angle': 'slipFeatureAngle', 'surface_normals_max_smoothing_iterations': 'surfaceNormalsMaxSmoothingIterations'}¶
- property buffer_cells_no_extrude¶
Gets the buffer_cells_no_extrude of this LayerAddingControls. # noqa: E501
<p>This parameter specifies the number of buffer cells to be extruded at cell-faces where layers terminate. Set to < 0 to disable.</p> # noqa: E501
- Returns
The buffer_cells_no_extrude of this LayerAddingControls. # noqa: E501
- Return type
int
- property feature_angle¶
Gets the feature_angle of this LayerAddingControls. # noqa: E501
- Returns
The feature_angle of this LayerAddingControls. # noqa: E501
- Return type
- property internal_mesh_max_smoothing_iterations¶
Gets the internal_mesh_max_smoothing_iterations of this LayerAddingControls. # noqa: E501
<p>Specify the number of smoothing iterations for the interior mesh movement. This movement occurs in order to make space for layers.</p> # noqa: E501
- Returns
The internal_mesh_max_smoothing_iterations of this LayerAddingControls. # noqa: E501
- Return type
int
- property layer_addition_max_iterations¶
Gets the layer_addition_max_iterations of this LayerAddingControls. # noqa: E501
<p>Specify the overall layer addition iteration number. The algorithm will abort definitely as soon as this number is reached. In this case, the mesh might be illegal.</p> # noqa: E501
- Returns
The layer_addition_max_iterations of this LayerAddingControls. # noqa: E501
- Return type
int
- property layer_thickness_max_smoothing_iterations¶
Gets the layer_thickness_max_smoothing_iterations of this LayerAddingControls. # noqa: E501
<p>This specifies the number of iterations for smoothing of the overall layer thickness over different surface patches.</p> # noqa: E501
- Returns
The layer_thickness_max_smoothing_iterations of this LayerAddingControls. # noqa: E501
- Return type
int
- property max_cancelled_layers_near_sharp_features¶
Gets the max_cancelled_layers_near_sharp_features of this LayerAddingControls. # noqa: E501
<p>If the algorithm faces difficulty generating layers, this is the maximum number of layers that are NOT generated in that region. Such cases might occur near sharp features. Set to 0 to force layer generation for all cases.</p> # noqa: E501
- Returns
The max_cancelled_layers_near_sharp_features of this LayerAddingControls. # noqa: E501
- Return type
int
- property max_face_thickness_ratio¶
Gets the max_face_thickness_ratio of this LayerAddingControls. # noqa: E501
<p>Specify the maximum allowable face aspect ratio beyond which layers will not be added.</p> # noqa: E501
- Returns
The max_face_thickness_ratio of this LayerAddingControls. # noqa: E501
- Return type
float
- property max_iterations_with_strict_quality_controls¶
Gets the max_iterations_with_strict_quality_controls of this LayerAddingControls. # noqa: E501
<p>This parameter specifies the maximum number of layer iterations that are done with the mesh quality controls. On exceeding these, the algorithm switches to less strict controls specified in the ‘relaxed’ category.</p> # noqa: E501
- Returns
The max_iterations_with_strict_quality_controls of this LayerAddingControls. # noqa: E501
- Return type
int
- property max_thickness_to_medial_ratio¶
Gets the max_thickness_to_medial_ratio of this LayerAddingControls. # noqa: E501
<p>The medial length is a measure of the aspect ratio for a non-quadrilateral face. This parameter prevents layer addition for non-quad faces that are highly anisotropic.</p> # noqa: E501
- Returns
The max_thickness_to_medial_ratio of this LayerAddingControls. # noqa: E501
- Return type
float
- property min_median_axis_angle¶
Gets the min_median_axis_angle of this LayerAddingControls. # noqa: E501
- Returns
The min_median_axis_angle of this LayerAddingControls. # noqa: E501
- Return type
- openapi_types = {'buffer_cells_no_extrude': 'int', 'feature_angle': 'DimensionalAngle', 'internal_mesh_max_smoothing_iterations': 'int', 'layer_addition_max_iterations': 'int', 'layer_thickness_max_smoothing_iterations': 'int', 'max_cancelled_layers_near_sharp_features': 'int', 'max_face_thickness_ratio': 'float', 'max_iterations_with_strict_quality_controls': 'int', 'max_thickness_to_medial_ratio': 'float', 'min_median_axis_angle': 'DimensionalAngle', 'relative_size': 'bool', 'relax_iterations': 'int', 'slip_feature_angle': 'DimensionalAngle', 'surface_normals_max_smoothing_iterations': 'int'}¶
- property relative_size¶
Gets the relative_size of this LayerAddingControls. # noqa: E501
<p>If turned on, the length parameters for layer refinements (e.g. ‘Thickness of the final layer’, ‘Minimum overall layer thickness’) are multiplied by the local cell size outside that layer. Else, they are used as absolute lengths.</p> # noqa: E501
- Returns
The relative_size of this LayerAddingControls. # noqa: E501
- Return type
bool
- property relax_iterations¶
Gets the relax_iterations of this LayerAddingControls. # noqa: E501
<p>Specify the maximum number of relaxation iterations for the snapping process for layers.</p> # noqa: E501
- Returns
The relax_iterations of this LayerAddingControls. # noqa: E501
- Return type
int
- property slip_feature_angle¶
Gets the slip_feature_angle of this LayerAddingControls. # noqa: E501
- Returns
The slip_feature_angle of this LayerAddingControls. # noqa: E501
- Return type
- property surface_normals_max_smoothing_iterations¶
Gets the surface_normals_max_smoothing_iterations of this LayerAddingControls. # noqa: E501
<p>Specify the maximum number of smoothing iterations for the surface normals.</p> # noqa: E501
- Returns
The surface_normals_max_smoothing_iterations of this LayerAddingControls. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.layer_addition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.layer_addition.LayerAddition(type='LAYER_ADDITION', name=None, layers=None, expansion_ratio=None, min_thickness=None, final_layer_thickness=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'expansion_ratio': 'expansionRatio', 'final_layer_thickness': 'finalLayerThickness', 'layers': 'layers', 'min_thickness': 'minThickness', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property expansion_ratio¶
Gets the expansion_ratio of this LayerAddition. # noqa: E501
<p>The <b>Expansion ratio</b> determines how the boundary layers grow in thickness from the wall to the internal mesh. The larger the ratio, the larger each cell layer will be in comparison to the neighbouring layer closer to the wall.</p><p><img src=”/spec/resources/help/imgs/shm_bl_expansion-ratio.png” class=”helpPopupImage”/> The figure shows a ratio of 1.3.</p> # noqa: E501
- Returns
The expansion_ratio of this LayerAddition. # noqa: E501
- Return type
float
- property final_layer_thickness¶
Gets the final_layer_thickness of this LayerAddition. # noqa: E501
<p>Specify the desired final layer thickness farthest away from the wall on which the boundary layer is grown. If the ‘Layer Size’ toggle in the hex-parametric global settings is turned on, this thickness is relative to the undistorted size of the cells in the internal mesh directly next to the boundary layer.</p> # noqa: E501
- Returns
The final_layer_thickness of this LayerAddition. # noqa: E501
- Return type
float
- property layers¶
Gets the layers of this LayerAddition. # noqa: E501
The number of <b>layers</b> defines how many boundary layers should be created. # noqa: E501
- Returns
The layers of this LayerAddition. # noqa: E501
- Return type
int
- property min_thickness¶
Gets the min_thickness of this LayerAddition. # noqa: E501
<p>This is the overall minimum thickness of all added layers. If for any case the overall layer thickness is smaller than this value, the layer addition process is stopped and no layers are added. In case the ‘Use relative size for layers?’ option in the global settings is set to ‘true’, this thickness is relative to the undistorted size of the cells in the internal mesh directly next to the boundary layer.</p> # noqa: E501
- Returns
The min_thickness of this LayerAddition. # noqa: E501
- Return type
float
- property name¶
Gets the name of this LayerAddition. # noqa: E501
- Returns
The name of this LayerAddition. # noqa: E501
- Return type
str
- openapi_types = {'expansion_ratio': 'float', 'final_layer_thickness': 'float', 'layers': 'int', 'min_thickness': 'float', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this LayerAddition. # noqa: E501
- Returns
The topological_reference of this LayerAddition. # noqa: E501
- Return type
- property type¶
Gets the type of this LayerAddition. # noqa: E501
<a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#layers-refinement’ target=’_blank’><b>Inflated boundary layers</b></a> are used to resolve the boundary layer near walls (no-slip) which are in contact with the fluid. Using boundary layers is generally recommended for turbulent simulations. Schema name: LayerAddition # noqa: E501
- Returns
The type of this LayerAddition. # noqa: E501
- Return type
str
simscale_sdk.models.layer_addition_hex_dominant_snappy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.layer_addition_hex_dominant_snappy.LayerAdditionHexDominantSnappy(type='LAYER_ADDITION_HEX_DOMINANT_SNAPPY', name=None, layers=None, expansion_ratio=None, min_thickness=None, first_layer_thickness=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'expansion_ratio': 'expansionRatio', 'first_layer_thickness': 'firstLayerThickness', 'layers': 'layers', 'min_thickness': 'minThickness', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property expansion_ratio¶
Gets the expansion_ratio of this LayerAdditionHexDominantSnappy. # noqa: E501
<p>The <b>Expansion ratio</b> determines how the boundary layers grow in thickness from the wall to the internal mesh. The larger the ratio, the larger each cell layer will be in comparison to the neighbouring layer closer to the wall.</p><p><img src=”/spec/resources/help/imgs/shm_bl_expansion-ratio.png” class=”helpPopupImage”/> The figure shows a ratio of 1.3.</p> # noqa: E501
- Returns
The expansion_ratio of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
float
- property first_layer_thickness¶
Gets the first_layer_thickness of this LayerAdditionHexDominantSnappy. # noqa: E501
Specifies the height (thickness) of the <b>first layer</b> that is closest to the surface. The first layer thickness is specified <b>relative</b> to the neighboring volume cell size after refinements. # noqa: E501
- Returns
The first_layer_thickness of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
float
- property layers¶
Gets the layers of this LayerAdditionHexDominantSnappy. # noqa: E501
The number of <b>layers</b> defines how many boundary layers should be created. # noqa: E501
- Returns
The layers of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
int
- property min_thickness¶
Gets the min_thickness of this LayerAdditionHexDominantSnappy. # noqa: E501
Specifies the <b>overall minimum thickness of all layers combined</b>. In case the overall thickness falls below this minimum thickness, no layers will be added for the affected areas. # noqa: E501
- Returns
The min_thickness of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
float
- property name¶
Gets the name of this LayerAdditionHexDominantSnappy. # noqa: E501
- Returns
The name of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
str
- openapi_types = {'expansion_ratio': 'float', 'first_layer_thickness': 'float', 'layers': 'int', 'min_thickness': 'float', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this LayerAdditionHexDominantSnappy. # noqa: E501
- Returns
The topological_reference of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
- property type¶
Gets the type of this LayerAdditionHexDominantSnappy. # noqa: E501
<a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#layers-refinement’ target=’_blank’><b>Inflated boundary layers</b></a> are used to resolve the boundary layer near walls (no-slip) which are in contact with the fluid. Using boundary layers is generally recommended for turbulent simulations. Schema name: LayerAdditionHexDominantSnappy # noqa: E501
- Returns
The type of this LayerAdditionHexDominantSnappy. # noqa: E501
- Return type
str
simscale_sdk.models.layer_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.layer_refinement.LayerRefinement(type='LAYER_INFLATION', name=None, total_thickness=None, layers=None, stretch_factor=None, allow_quadrangles=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property allow_quadrangles¶
Gets the allow_quadrangles of this LayerRefinement. # noqa: E501
<p>This parameter determines if <a href=’https://www.simscale.com/docs/simulation-setup/meshing/tet-dominant/#quadrangles’ target=’_blank’><b>quadrangular surface elements</b></a> shall be allowed. When disabled, only triangles will be used. Meshing with triangles only is usually more robust while quadrangular elements may lead to better results.</p><p><img src=”/spec/resources/help/imgs/allow_quads_comparison.png” class=”helpPopupImage”/> The figure shows sample meshes with quadrangular surface elements disallowed (left) and allowed (right).</p> # noqa: E501
- Returns
The allow_quadrangles of this LayerRefinement. # noqa: E501
- Return type
bool
- attribute_map = {'allow_quadrangles': 'allowQuadrangles', 'layers': 'layers', 'name': 'name', 'stretch_factor': 'stretchFactor', 'topological_reference': 'topologicalReference', 'total_thickness': 'totalThickness', 'type': 'type'}¶
- property layers¶
Gets the layers of this LayerRefinement. # noqa: E501
The number of <b>layers</b> defines how many prismatic boundary layers should be created. # noqa: E501
- Returns
The layers of this LayerRefinement. # noqa: E501
- Return type
int
- property name¶
Gets the name of this LayerRefinement. # noqa: E501
- Returns
The name of this LayerRefinement. # noqa: E501
- Return type
str
- openapi_types = {'allow_quadrangles': 'bool', 'layers': 'int', 'name': 'str', 'stretch_factor': 'float', 'topological_reference': 'TopologicalReference', 'total_thickness': 'float', 'type': 'str'}¶
- property stretch_factor¶
Gets the stretch_factor of this LayerRefinement. # noqa: E501
<p>The <b>stretch factor</b> determines how the boundary layers grow in thickness from the wall to the internal mesh. The larger the ratio, the larger each element layer will be in comparison to the neighbouring layer closer to the wall.</p><p><img src=”/spec/resources/help/imgs/shm_bl_expansion-ratio.png” class=”helpPopupImage”/> The figure shows a ratio of 1.3.</p> # noqa: E501
- Returns
The stretch_factor of this LayerRefinement. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this LayerRefinement. # noqa: E501
- Returns
The topological_reference of this LayerRefinement. # noqa: E501
- Return type
- property total_thickness¶
Gets the total_thickness of this LayerRefinement. # noqa: E501
This parameter controls the <b>overall thickness</b> of all the generated boundary layers together. This value must be smaller than the minimal geometry thickness at the specified locations, otherwise the meshing will fail. # noqa: E501
- Returns
The total_thickness of this LayerRefinement. # noqa: E501
- Return type
float
- property type¶
Gets the type of this LayerRefinement. # noqa: E501
<p><a href=’https://www.simscale.com/docs/simulation-setup/meshing/tet-dominant/#layer-inflation’ target=’_blank’><b>Layer inflation</b></a> allows the creation of prismatic boundary layers for certain mesh regions.</p><p>Prismatic layers are mostly used in CFD simulations on no-slip walls in order to efficiently capture the boundary layer velocity profile, but they may be also used in certain structural simulations like stamping or deep-drawing processes.</p><p><img src=”/spec/resources/help/imgs/boundary-layer.png” class=”helpPopupImage”/> The figure shows a sample mesh with boundary layers added.</p> Schema name: LayerRefinement # noqa: E501
- Returns
The type of this LayerRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.layer_wall_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.layer_wall_thermal.LayerWallThermal(type='CONTACT_INTERFACE_MATERIAL', conductivity_thickness_pairs=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'conductivity_thickness_pairs': 'conductivityThicknessPairs', 'type': 'type'}¶
- property conductivity_thickness_pairs¶
Gets the conductivity_thickness_pairs of this LayerWallThermal. # noqa: E501
- Returns
The conductivity_thickness_pairs of this LayerWallThermal. # noqa: E501
- Return type
- openapi_types = {'conductivity_thickness_pairs': 'list[ConductivityThicknessPair]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LayerWallThermal. # noqa: E501
Schema name: LayerWallThermal # noqa: E501
- Returns
The type of this LayerWallThermal. # noqa: E501
- Return type
str
simscale_sdk.models.ldlt_solver_v33 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ldlt_solver_v33.LDLTSolverV33(type='LDLT_V33', force_symmetric=None, precision_singularity_detection=None, stop_if_singular=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'force_symmetric': 'forceSymmetric', 'precision_singularity_detection': 'precisionSingularityDetection', 'stop_if_singular': 'stopIfSingular', 'type': 'type'}¶
- property force_symmetric¶
Gets the force_symmetric of this LDLTSolverV33. # noqa: E501
Choose if you want to enforce a symmetric matrix. # noqa: E501
- Returns
The force_symmetric of this LDLTSolverV33. # noqa: E501
- Return type
bool
- openapi_types = {'force_symmetric': 'bool', 'precision_singularity_detection': 'int', 'stop_if_singular': 'bool', 'type': 'str'}¶
- property precision_singularity_detection¶
Gets the precision_singularity_detection of this LDLTSolverV33. # noqa: E501
Define the precision value for the detection of a singular matrix. # noqa: E501
- Returns
The precision_singularity_detection of this LDLTSolverV33. # noqa: E501
- Return type
int
- property stop_if_singular¶
Gets the stop_if_singular of this LDLTSolverV33. # noqa: E501
Choose if the calculation should be stopped if the problem turns out to be singular. # noqa: E501
- Returns
The stop_if_singular of this LDLTSolverV33. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LDLTSolverV33. # noqa: E501
<p>Choose a linear equation system solver for your calculation:</p><ul><li><p><b>Multfront</b> is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.</p></ul><ul><li><p><b>MUMPS</b> is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.</p></ul><ul><li><p><b>LDLT</b> is a direct solver which uses a Gaussian Algortihm. It is comparatively slow for big problems.</p></ul><ul><li><p><b>PETSC</b> is an iterative solver specially designed to deal with large systems. It scales very effectively in parallel and is the best choice for large problems.</p></ul><ul><li><p><b>GCPC</b> is an iterative solver of the pre-conditioned conjugate gradient type. It scales well in parallel and is also usable for large problems.</p></ul> Schema name: LDLTSolverV33 # noqa: E501
- Returns
The type of this LDLTSolverV33. # noqa: E501
- Return type
str
simscale_sdk.models.leastsquares_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.leastsquares_gradient_scheme.LeastsquaresGradientScheme(type='LEASTSQUARES', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LeastsquaresGradientScheme. # noqa: E501
Schema name: LeastsquaresGradientScheme # noqa: E501
- Returns
The type of this LeastsquaresGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.limited_surface_normal_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.limited_surface_normal_gradient_scheme.LimitedSurfaceNormalGradientScheme(type='LIMITED', limiter_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'limiter_coefficient': 'limiterCoefficient', 'type': 'type'}¶
- property limiter_coefficient¶
Gets the limiter_coefficient of this LimitedSurfaceNormalGradientScheme. # noqa: E501
This property defines a limiter coefficient for the scheme:<ul><li><strong>0</strong>: no correction, equivalent to the uncorrected scheme</li><li><strong>1</strong>: full non-orthogonal correction applied</li><li><strong>0.5</strong>: non-orthogonal contribution does not exceed the orthogonal part</li></ul> # noqa: E501
- Returns
The limiter_coefficient of this LimitedSurfaceNormalGradientScheme. # noqa: E501
- Return type
float
- openapi_types = {'limiter_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LimitedSurfaceNormalGradientScheme. # noqa: E501
Schema name: LimitedSurfaceNormalGradientScheme # noqa: E501
- Returns
The type of this LimitedSurfaceNormalGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.linear_elastic_material_behavior module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.linear_elastic_material_behavior.LinearElasticMaterialBehavior(type='LINEAR_ELASTIC', directional_dependency=None, damping=None, creep_formulation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'creep_formulation': 'creepFormulation', 'damping': 'damping', 'directional_dependency': 'directionalDependency', 'type': 'type'}¶
- property creep_formulation¶
Gets the creep_formulation of this LinearElasticMaterialBehavior. # noqa: E501
- Returns
The creep_formulation of this LinearElasticMaterialBehavior. # noqa: E501
- Return type
OneOfLinearElasticMaterialBehaviorCreepFormulation
- property damping¶
Gets the damping of this LinearElasticMaterialBehavior. # noqa: E501
- Returns
The damping of this LinearElasticMaterialBehavior. # noqa: E501
- Return type
OneOfLinearElasticMaterialBehaviorDamping
- property directional_dependency¶
Gets the directional_dependency of this LinearElasticMaterialBehavior. # noqa: E501
- Returns
The directional_dependency of this LinearElasticMaterialBehavior. # noqa: E501
- Return type
- openapi_types = {'creep_formulation': 'OneOfLinearElasticMaterialBehaviorCreepFormulation', 'damping': 'OneOfLinearElasticMaterialBehaviorDamping', 'directional_dependency': 'IsotropicDirectionalDependency', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LinearElasticMaterialBehavior. # noqa: E501
<p>Choose the material behavior for your problem. </p> <br /><br />Important remarks:<br /> <ul><li>Choose <b>Linear elastic</b> if the stress-strain relationship of your material is linear.</li><li>Choose <b>Elasto-plastic</b> if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.</li><li>Choose <b>Hyperelastic</b> if your material responds elastically even at higher deformations.</li></ul> Schema name: LinearElasticMaterialBehavior # noqa: E501
- Returns
The type of this LinearElasticMaterialBehavior. # noqa: E501
- Return type
str
simscale_sdk.models.linear_interpolation_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.linear_interpolation_scheme.LinearInterpolationScheme(type='LINEAR', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LinearInterpolationScheme. # noqa: E501
Schema name: LinearInterpolationScheme # noqa: E501
- Returns
The type of this LinearInterpolationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.linear_sbm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.linear_sbm.LinearSBM(type='LINEAR_MOTION', name=None, velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'type': 'type', 'velocity': 'velocity'}¶
- property name¶
Gets the name of this LinearSBM. # noqa: E501
- Returns
The name of this LinearSBM. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'type': 'str', 'velocity': 'DimensionalVectorSpeed'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LinearSBM. # noqa: E501
Schema name: LinearSBM # noqa: E501
- Returns
The type of this LinearSBM. # noqa: E501
- Return type
str
- property velocity¶
Gets the velocity of this LinearSBM. # noqa: E501
- Returns
The velocity of this LinearSBM. # noqa: E501
- Return type
simscale_sdk.models.local_cartesian_box module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.local_cartesian_box.LocalCartesianBox(type='LOCAL_CARTESIAN_BOX', id=None, name=None, orientation_reference=None, min=None, max=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'max': 'max', 'min': 'min', 'name': 'name', 'orientation_reference': 'orientationReference', 'type': 'type'}¶
- property id¶
Gets the id of this LocalCartesianBox. # noqa: E501
- Returns
The id of this LocalCartesianBox. # noqa: E501
- Return type
str
- property max¶
Gets the max of this LocalCartesianBox. # noqa: E501
- Returns
The max of this LocalCartesianBox. # noqa: E501
- Return type
- property min¶
Gets the min of this LocalCartesianBox. # noqa: E501
- Returns
The min of this LocalCartesianBox. # noqa: E501
- Return type
- property name¶
Gets the name of this LocalCartesianBox. # noqa: E501
- Returns
The name of this LocalCartesianBox. # noqa: E501
- Return type
str
- openapi_types = {'id': 'str', 'max': 'DimensionalVectorLength', 'min': 'DimensionalVectorLength', 'name': 'str', 'orientation_reference': 'str', 'type': 'str'}¶
- property orientation_reference¶
Gets the orientation_reference of this LocalCartesianBox. # noqa: E501
- Returns
The orientation_reference of this LocalCartesianBox. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LocalCartesianBox. # noqa: E501
Schema name: LocalCartesianBox # noqa: E501
- Returns
The type of this LocalCartesianBox. # noqa: E501
- Return type
str
simscale_sdk.models.local_euler_time_differentiation_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.local_euler_time_differentiation_scheme.LocalEulerTimeDifferentiationScheme(type='LOCAL_EULER', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LocalEulerTimeDifferentiationScheme. # noqa: E501
Schema name: LocalEulerTimeDifferentiationScheme # noqa: E501
- Returns
The type of this LocalEulerTimeDifferentiationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.local_half_space module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.local_half_space.LocalHalfSpace(type='LOCAL_HALF_SPACE', id=None, name=None, orientation_reference=None, reference_point=None, normal=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'name': 'name', 'normal': 'normal', 'orientation_reference': 'orientationReference', 'reference_point': 'referencePoint', 'type': 'type'}¶
- property id¶
Gets the id of this LocalHalfSpace. # noqa: E501
- Returns
The id of this LocalHalfSpace. # noqa: E501
- Return type
str
- property name¶
Gets the name of this LocalHalfSpace. # noqa: E501
- Returns
The name of this LocalHalfSpace. # noqa: E501
- Return type
str
- property normal¶
Gets the normal of this LocalHalfSpace. # noqa: E501
- Returns
The normal of this LocalHalfSpace. # noqa: E501
- Return type
- openapi_types = {'id': 'str', 'name': 'str', 'normal': 'DimensionalVectorLength', 'orientation_reference': 'str', 'reference_point': 'DimensionalVectorLength', 'type': 'str'}¶
- property orientation_reference¶
Gets the orientation_reference of this LocalHalfSpace. # noqa: E501
- Returns
The orientation_reference of this LocalHalfSpace. # noqa: E501
- Return type
str
- property reference_point¶
Gets the reference_point of this LocalHalfSpace. # noqa: E501
- Returns
The reference_point of this LocalHalfSpace. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LocalHalfSpace. # noqa: E501
Schema name: LocalHalfSpace # noqa: E501
- Returns
The type of this LocalHalfSpace. # noqa: E501
- Return type
str
simscale_sdk.models.local_sphere module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.local_sphere.LocalSphere(type='LOCAL_SPHERE', id=None, name=None, orientation_reference=None, center=None, radius=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center': 'center', 'id': 'id', 'name': 'name', 'orientation_reference': 'orientationReference', 'radius': 'radius', 'type': 'type'}¶
- property center¶
Gets the center of this LocalSphere. # noqa: E501
- Returns
The center of this LocalSphere. # noqa: E501
- Return type
- property id¶
Gets the id of this LocalSphere. # noqa: E501
- Returns
The id of this LocalSphere. # noqa: E501
- Return type
str
- property name¶
Gets the name of this LocalSphere. # noqa: E501
- Returns
The name of this LocalSphere. # noqa: E501
- Return type
str
- openapi_types = {'center': 'DimensionalVectorLength', 'id': 'str', 'name': 'str', 'orientation_reference': 'str', 'radius': 'DimensionalLength', 'type': 'str'}¶
- property orientation_reference¶
Gets the orientation_reference of this LocalSphere. # noqa: E501
- Returns
The orientation_reference of this LocalSphere. # noqa: E501
- Return type
str
- property radius¶
Gets the radius of this LocalSphere. # noqa: E501
- Returns
The radius of this LocalSphere. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this LocalSphere. # noqa: E501
Schema name: LocalSphere # noqa: E501
- Returns
The type of this LocalSphere. # noqa: E501
- Return type
str
simscale_sdk.models.log_entry module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.log_entry.LogEntry(severity=None, code=None, message=None, details=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'code': 'code', 'details': 'details', 'message': 'message', 'severity': 'severity'}¶
- property code¶
Gets the code of this LogEntry. # noqa: E501
Code for e.g. programmatic handling of error conditions. # noqa: E501
- Returns
The code of this LogEntry. # noqa: E501
- Return type
str
- property details¶
Gets the details of this LogEntry. # noqa: E501
Additional data to interpret and handle the entry. # noqa: E501
- Returns
The details of this LogEntry. # noqa: E501
- Return type
dict(str, object)
- property message¶
Gets the message of this LogEntry. # noqa: E501
Human-readable description of the entry. # noqa: E501
- Returns
The message of this LogEntry. # noqa: E501
- Return type
str
- openapi_types = {'code': 'str', 'details': 'dict(str, object)', 'message': 'str', 'severity': 'LogSeverity'}¶
- property severity¶
Gets the severity of this LogEntry. # noqa: E501
- Returns
The severity of this LogEntry. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.log_severity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.log_severity.LogSeverity(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- ERROR = 'ERROR'¶
- INFO = 'INFO'¶
- SUCCESS = 'SUCCESS'¶
- WARNING = 'WARNING'¶
- allowable_values = ['INFO', 'SUCCESS', 'WARNING', 'ERROR']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.manual_mesh_grading module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_mesh_grading.ManualMeshGrading(type='MANUAL', number_of_segments_per_edge=None, number_of_segments_per_radius=None, growth_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'growth_rate': 'growthRate', 'number_of_segments_per_edge': 'numberOfSegmentsPerEdge', 'number_of_segments_per_radius': 'numberOfSegmentsPerRadius', 'type': 'type'}¶
- property growth_rate¶
Gets the growth_rate of this ManualMeshGrading. # noqa: E501
<p>The <b>growth rate</b> determines how large the allowed difference in element size between neighbouring elements is. For example a value of 0.2 allows the edges of neighbouring elements to differ by 20%.</p><p>If a large value is chosen, features requiring a finer mesh, like holes or fillets, will have a very local influence on the element size whereas for a small mesh grading those features will influence the element sizes in a wider area around them.</p><p>Choosing a smaller value will thus lead to a higher number of elements but also result in a better overall mesh quality.</p><p><img src=”/spec/resources/help/imgs/growth_rate_comparison.png” class=”helpPopupImage”/> The figure shows meshes for growth rate <i>2</i> (left) and <i>0.2</i> (right).</p> # noqa: E501
- Returns
The growth_rate of this ManualMeshGrading. # noqa: E501
- Return type
float
- property number_of_segments_per_edge¶
Gets the number_of_segments_per_edge of this ManualMeshGrading. # noqa: E501
<p>This value defines the minimum number of elements along a <b>geometry edge</b>.</p> # noqa: E501
- Returns
The number_of_segments_per_edge of this ManualMeshGrading. # noqa: E501
- Return type
float
- property number_of_segments_per_radius¶
Gets the number_of_segments_per_radius of this ManualMeshGrading. # noqa: E501
<p>This value defines the minimum number of elements along a <b>geometry radius</b>.</p> # noqa: E501
- Returns
The number_of_segments_per_radius of this ManualMeshGrading. # noqa: E501
- Return type
float
- openapi_types = {'growth_rate': 'float', 'number_of_segments_per_edge': 'float', 'number_of_segments_per_radius': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualMeshGrading. # noqa: E501
Schema name: ManualMeshGrading # noqa: E501
- Returns
The type of this ManualMeshGrading. # noqa: E501
- Return type
str
simscale_sdk.models.manual_mesh_sizing module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_mesh_sizing.ManualMeshSizing(type='MANUAL', minimum_edge_length=None, maximum_edge_length=None, grading=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'grading': 'grading', 'maximum_edge_length': 'maximumEdgeLength', 'minimum_edge_length': 'minimumEdgeLength', 'type': 'type'}¶
- property grading¶
Gets the grading of this ManualMeshSizing. # noqa: E501
- Returns
The grading of this ManualMeshSizing. # noqa: E501
- Return type
OneOfManualMeshSizingGrading
- property maximum_edge_length¶
Gets the maximum_edge_length of this ManualMeshSizing. # noqa: E501
- Returns
The maximum_edge_length of this ManualMeshSizing. # noqa: E501
- Return type
- property minimum_edge_length¶
Gets the minimum_edge_length of this ManualMeshSizing. # noqa: E501
- Returns
The minimum_edge_length of this ManualMeshSizing. # noqa: E501
- Return type
- openapi_types = {'grading': 'OneOfManualMeshSizingGrading', 'maximum_edge_length': 'DimensionalLength', 'minimum_edge_length': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualMeshSizing. # noqa: E501
Schema name: ManualMeshSizing # noqa: E501
- Returns
The type of this ManualMeshSizing. # noqa: E501
- Return type
str
simscale_sdk.models.manual_mesh_sizing_hex_dominant_snappy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_mesh_sizing_hex_dominant_snappy.ManualMeshSizingHexDominantSnappy(type='MANUAL', minimum_edge_length=None, maximum_edge_length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'maximum_edge_length': 'maximumEdgeLength', 'minimum_edge_length': 'minimumEdgeLength', 'type': 'type'}¶
- property maximum_edge_length¶
Gets the maximum_edge_length of this ManualMeshSizingHexDominantSnappy. # noqa: E501
- Returns
The maximum_edge_length of this ManualMeshSizingHexDominantSnappy. # noqa: E501
- Return type
- property minimum_edge_length¶
Gets the minimum_edge_length of this ManualMeshSizingHexDominantSnappy. # noqa: E501
- Returns
The minimum_edge_length of this ManualMeshSizingHexDominantSnappy. # noqa: E501
- Return type
- openapi_types = {'maximum_edge_length': 'DimensionalLength', 'minimum_edge_length': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualMeshSizingHexDominantSnappy. # noqa: E501
Schema name: ManualMeshSizingHexDominantSnappy # noqa: E501
- Returns
The type of this ManualMeshSizingHexDominantSnappy. # noqa: E501
- Return type
str
simscale_sdk.models.manual_mesh_sizing_simmetrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_mesh_sizing_simmetrix.ManualMeshSizingSimmetrix(type='MANUAL', maximum_edge_length=None, minimum_edge_length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'maximum_edge_length': 'maximumEdgeLength', 'minimum_edge_length': 'minimumEdgeLength', 'type': 'type'}¶
- property maximum_edge_length¶
Gets the maximum_edge_length of this ManualMeshSizingSimmetrix. # noqa: E501
- Returns
The maximum_edge_length of this ManualMeshSizingSimmetrix. # noqa: E501
- Return type
- property minimum_edge_length¶
Gets the minimum_edge_length of this ManualMeshSizingSimmetrix. # noqa: E501
- Returns
The minimum_edge_length of this ManualMeshSizingSimmetrix. # noqa: E501
- Return type
- openapi_types = {'maximum_edge_length': 'DimensionalLength', 'minimum_edge_length': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualMeshSizingSimmetrix. # noqa: E501
Schema name: ManualMeshSizingSimmetrix # noqa: E501
- Returns
The type of this ManualMeshSizingSimmetrix. # noqa: E501
- Return type
str
simscale_sdk.models.manual_reactualization module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_reactualization.ManualReactualization(type='MANUAL', num_iterations=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'num_iterations': 'numIterations', 'type': 'type'}¶
- property num_iterations¶
Gets the num_iterations of this ManualReactualization. # noqa: E501
- Returns
The num_iterations of this ManualReactualization. # noqa: E501
- Return type
int
- openapi_types = {'num_iterations': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualReactualization. # noqa: E501
Schema name: ManualReactualization # noqa: E501
- Returns
The type of this ManualReactualization. # noqa: E501
- Return type
str
simscale_sdk.models.manual_reference_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_reference_length.ManualReferenceLength(type='MANUAL_REFERENCE_LENGTH', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalLength'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualReferenceLength. # noqa: E501
Schema name: ManualReferenceLength # noqa: E501
- Returns
The type of this ManualReferenceLength. # noqa: E501
- Return type
str
- property value¶
Gets the value of this ManualReferenceLength. # noqa: E501
- Returns
The value of this ManualReferenceLength. # noqa: E501
- Return type
simscale_sdk.models.manual_region_sizing_pacefish module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_region_sizing_pacefish.ManualRegionSizingPacefish(type='MANUAL_REGION_PACEFISH', target_resolution=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'target_resolution': 'targetResolution', 'type': 'type'}¶
- openapi_types = {'target_resolution': 'DimensionalLength', 'type': 'str'}¶
- property target_resolution¶
Gets the target_resolution of this ManualRegionSizingPacefish. # noqa: E501
- Returns
The target_resolution of this ManualRegionSizingPacefish. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualRegionSizingPacefish. # noqa: E501
Schema name: ManualRegionSizingPacefish # noqa: E501
- Returns
The type of this ManualRegionSizingPacefish. # noqa: E501
- Return type
str
simscale_sdk.models.manual_simerics_mesh_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_simerics_mesh_settings.ManualSimericsMeshSettings(type='MANUAL_SETTINGS', refinements=None, minimum_cell_size=None, maximum_cell_size=None, cell_size_on_surfaces=None, enable_growth_rate=None, growth_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cell_size_on_surfaces': 'cellSizeOnSurfaces', 'enable_growth_rate': 'enableGrowthRate', 'growth_rate': 'growthRate', 'maximum_cell_size': 'maximumCellSize', 'minimum_cell_size': 'minimumCellSize', 'refinements': 'refinements', 'type': 'type'}¶
- property cell_size_on_surfaces¶
Gets the cell_size_on_surfaces of this ManualSimericsMeshSettings. # noqa: E501
- Returns
The cell_size_on_surfaces of this ManualSimericsMeshSettings. # noqa: E501
- Return type
- property enable_growth_rate¶
Gets the enable_growth_rate of this ManualSimericsMeshSettings. # noqa: E501
<p><b>Specify growth rate</b>: Define the cell size growth rate between interior cells and surface cells.</p> # noqa: E501
- Returns
The enable_growth_rate of this ManualSimericsMeshSettings. # noqa: E501
- Return type
bool
- property growth_rate¶
Gets the growth_rate of this ManualSimericsMeshSettings. # noqa: E501
The <i>Growth rate</i> defines the cell size ratio between interior cell size and surface cell size. It needs to be <b>a whole number</b> always greater than 1 and smaller or equal to 8, such that the cell size increases towards the interior of the mesh. # noqa: E501
- Returns
The growth_rate of this ManualSimericsMeshSettings. # noqa: E501
- Return type
int
- property maximum_cell_size¶
Gets the maximum_cell_size of this ManualSimericsMeshSettings. # noqa: E501
- Returns
The maximum_cell_size of this ManualSimericsMeshSettings. # noqa: E501
- Return type
- property minimum_cell_size¶
Gets the minimum_cell_size of this ManualSimericsMeshSettings. # noqa: E501
- Returns
The minimum_cell_size of this ManualSimericsMeshSettings. # noqa: E501
- Return type
- openapi_types = {'cell_size_on_surfaces': 'DimensionalLength', 'enable_growth_rate': 'bool', 'growth_rate': 'int', 'maximum_cell_size': 'DimensionalLength', 'minimum_cell_size': 'DimensionalLength', 'refinements': 'list[RegionRefinementSimerics]', 'type': 'str'}¶
- property refinements¶
Gets the refinements of this ManualSimericsMeshSettings. # noqa: E501
- Returns
The refinements of this ManualSimericsMeshSettings. # noqa: E501
- Return type
list[RegionRefinementSimerics]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualSimericsMeshSettings. # noqa: E501
Schema name: ManualSimericsMeshSettings # noqa: E501
- Returns
The type of this ManualSimericsMeshSettings. # noqa: E501
- Return type
str
simscale_sdk.models.manual_surface_sizing_pacefish module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_surface_sizing_pacefish.ManualSurfaceSizingPacefish(type='MANUAL_SURFACE_PACEFISH', target_resolution=None, buffer_cells_no_extrude=None, additional_directional_cells=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property additional_directional_cells¶
Gets the additional_directional_cells of this ManualSurfaceSizingPacefish. # noqa: E501
- Returns
The additional_directional_cells of this ManualSurfaceSizingPacefish. # noqa: E501
- Return type
- attribute_map = {'additional_directional_cells': 'additionalDirectionalCells', 'buffer_cells_no_extrude': 'bufferCellsNoExtrude', 'target_resolution': 'targetResolution', 'type': 'type'}¶
- property buffer_cells_no_extrude¶
Gets the buffer_cells_no_extrude of this ManualSurfaceSizingPacefish. # noqa: E501
Specify the minimum number of buffer cells between regions of different refinements. # noqa: E501
- Returns
The buffer_cells_no_extrude of this ManualSurfaceSizingPacefish. # noqa: E501
- Return type
int
- openapi_types = {'additional_directional_cells': 'AdditionalDirectionalCells', 'buffer_cells_no_extrude': 'int', 'target_resolution': 'DimensionalLength', 'type': 'str'}¶
- property target_resolution¶
Gets the target_resolution of this ManualSurfaceSizingPacefish. # noqa: E501
- Returns
The target_resolution of this ManualSurfaceSizingPacefish. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualSurfaceSizingPacefish. # noqa: E501
Schema name: ManualSurfaceSizingPacefish # noqa: E501
- Returns
The type of this ManualSurfaceSizingPacefish. # noqa: E501
- Return type
str
simscale_sdk.models.manual_timestep_calculation_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_timestep_calculation_type.ManualTimestepCalculationType(type='MANUAL', additional_newton_iterations=None, fixed_subdivision=None, fixed_augmentation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property additional_newton_iterations¶
Gets the additional_newton_iterations of this ManualTimestepCalculationType. # noqa: E501
<p>Define the percentage of additional Newton Iterations that should be allowed to be used if convergence is not reached after the maximum number of Newton Iterations is reached.</p> # noqa: E501
- Returns
The additional_newton_iterations of this ManualTimestepCalculationType. # noqa: E501
- Return type
float
- attribute_map = {'additional_newton_iterations': 'additionalNewtonIterations', 'fixed_augmentation': 'fixedAugmentation', 'fixed_subdivision': 'fixedSubdivision', 'type': 'type'}¶
- property fixed_augmentation¶
Gets the fixed_augmentation of this ManualTimestepCalculationType. # noqa: E501
- Returns
The fixed_augmentation of this ManualTimestepCalculationType. # noqa: E501
- Return type
- property fixed_subdivision¶
Gets the fixed_subdivision of this ManualTimestepCalculationType. # noqa: E501
- Returns
The fixed_subdivision of this ManualTimestepCalculationType. # noqa: E501
- Return type
- openapi_types = {'additional_newton_iterations': 'float', 'fixed_augmentation': 'FixedAugmentation', 'fixed_subdivision': 'FixedSubdivision', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualTimestepCalculationType. # noqa: E501
<p>Select how the time increments should be computed in case of an adaptation event. Currently four types are available (which may not all be available for every event):</p><ul><li><p><b>Manual</b>: Here the user defines fixed time step subdivision and augmentation settings.</p></ul><ul><li><p><b>Newton Iterations Target</b>: With this setting the user defines a target value for the Newton Iterations and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Field Change Target</b>: With this setting the user defines a target value for change of a specific field component within a time increment and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Mixed</b>: The mixed type uses a fixed subdivision and an automatic adaptation of the time step with a target value for the change of the selected field component.</p></ul> Schema name: ManualTimestepCalculationType # noqa: E501
- Returns
The type of this ManualTimestepCalculationType. # noqa: E501
- Return type
str
simscale_sdk.models.manual_timestep_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.manual_timestep_definition.ManualTimestepDefinition(type='MANUAL_V19', simulation_interval=None, timestep_length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'simulation_interval': 'simulationInterval', 'timestep_length': 'timestepLength', 'type': 'type'}¶
- openapi_types = {'simulation_interval': 'DimensionalTime', 'timestep_length': 'RestrictedDimensionalFunctionTime', 'type': 'str'}¶
- property simulation_interval¶
Gets the simulation_interval of this ManualTimestepDefinition. # noqa: E501
- Returns
The simulation_interval of this ManualTimestepDefinition. # noqa: E501
- Return type
- property timestep_length¶
Gets the timestep_length of this ManualTimestepDefinition. # noqa: E501
- Returns
The timestep_length of this ManualTimestepDefinition. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ManualTimestepDefinition. # noqa: E501
Schema name: ManualTimestepDefinition # noqa: E501
- Returns
The type of this ManualTimestepDefinition. # noqa: E501
- Return type
str
simscale_sdk.models.mass_flow module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mass_flow.MassFlow(type='MASS', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionMassFlowRate'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MassFlow. # noqa: E501
<p>Defines the mass flow rate <strong>per each face</strong> of the assignment.</p> Schema name: MassFlow # noqa: E501
- Returns
The type of this MassFlow. # noqa: E501
- Return type
str
- property value¶
Gets the value of this MassFlow. # noqa: E501
- Returns
The value of this MassFlow. # noqa: E501
- Return type
simscale_sdk.models.material_group_list_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_group_list_response.MaterialGroupListResponse(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this MaterialGroupListResponse. # noqa: E501
- Returns
The embedded of this MaterialGroupListResponse. # noqa: E501
- Return type
list[MaterialGroupResponse]
- property links¶
Gets the links of this MaterialGroupListResponse. # noqa: E501
- Returns
The links of this MaterialGroupListResponse. # noqa: E501
- Return type
- property meta¶
Gets the meta of this MaterialGroupListResponse. # noqa: E501
- Returns
The meta of this MaterialGroupListResponse. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[MaterialGroupResponse]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_group_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_group_response.MaterialGroupResponse(material_group_id=None, parent_id=None, name=None, group_type=None, created_at=None, modified_at=None, metadata=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'group_type': 'groupType', 'material_group_id': 'materialGroupId', 'metadata': 'metadata', 'modified_at': 'modifiedAt', 'name': 'name', 'parent_id': 'parentId'}¶
- property created_at¶
Gets the created_at of this MaterialGroupResponse. # noqa: E501
The time the material group was created. # noqa: E501
- Returns
The created_at of this MaterialGroupResponse. # noqa: E501
- Return type
datetime
- property group_type¶
Gets the group_type of this MaterialGroupResponse. # noqa: E501
- Returns
The group_type of this MaterialGroupResponse. # noqa: E501
- Return type
- property material_group_id¶
Gets the material_group_id of this MaterialGroupResponse. # noqa: E501
The ID of the material group. # noqa: E501
- Returns
The material_group_id of this MaterialGroupResponse. # noqa: E501
- Return type
str
- property metadata¶
Gets the metadata of this MaterialGroupResponse. # noqa: E501
Material group metadata. # noqa: E501
- Returns
The metadata of this MaterialGroupResponse. # noqa: E501
- Return type
object
- property modified_at¶
Gets the modified_at of this MaterialGroupResponse. # noqa: E501
The time the material group was modified. # noqa: E501
- Returns
The modified_at of this MaterialGroupResponse. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this MaterialGroupResponse. # noqa: E501
The name of the material group. # noqa: E501
- Returns
The name of this MaterialGroupResponse. # noqa: E501
- Return type
str
- openapi_types = {'created_at': 'datetime', 'group_type': 'MaterialGroupType', 'material_group_id': 'str', 'metadata': 'object', 'modified_at': 'datetime', 'name': 'str', 'parent_id': 'str'}¶
- property parent_id¶
Gets the parent_id of this MaterialGroupResponse. # noqa: E501
The ID of parent of the material group. # noqa: E501
- Returns
The parent_id of this MaterialGroupResponse. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_group_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_group_type.MaterialGroupType(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- COMPANY_CUSTOM = 'COMPANY_CUSTOM'¶
- SIMSCALE_DEFAULT = 'SIMSCALE_DEFAULT'¶
- USER_CUSTOM = 'USER_CUSTOM'¶
- allowable_values = ['SIMSCALE_DEFAULT', 'USER_CUSTOM', 'COMPANY_CUSTOM']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_library_reference module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_library_reference.MaterialLibraryReference(material_group_id=None, material_id=None, interpolation_parameters=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'interpolation_parameters': 'interpolationParameters', 'material_group_id': 'materialGroupId', 'material_id': 'materialId'}¶
- property interpolation_parameters¶
Gets the interpolation_parameters of this MaterialLibraryReference. # noqa: E501
- Returns
The interpolation_parameters of this MaterialLibraryReference. # noqa: E501
- Return type
dict(str, InterpolationParameter)
- property material_group_id¶
Gets the material_group_id of this MaterialLibraryReference. # noqa: E501
- Returns
The material_group_id of this MaterialLibraryReference. # noqa: E501
- Return type
str
- property material_id¶
Gets the material_id of this MaterialLibraryReference. # noqa: E501
- Returns
The material_id of this MaterialLibraryReference. # noqa: E501
- Return type
str
- openapi_types = {'interpolation_parameters': 'dict(str, InterpolationParameter)', 'material_group_id': 'str', 'material_id': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_list_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_list_response.MaterialListResponse(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this MaterialListResponse. # noqa: E501
- Returns
The embedded of this MaterialListResponse. # noqa: E501
- Return type
list[MaterialResponse]
- property links¶
Gets the links of this MaterialListResponse. # noqa: E501
- Returns
The links of this MaterialListResponse. # noqa: E501
- Return type
- property meta¶
Gets the meta of this MaterialListResponse. # noqa: E501
- Returns
The meta of this MaterialListResponse. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[MaterialResponse]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_property_parameter module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_property_parameter.MaterialPropertyParameter(key=None, name=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'key': 'key', 'name': 'name', 'unit': 'unit'}¶
- property key¶
Gets the key of this MaterialPropertyParameter. # noqa: E501
The unique identifier of the parameter, meaningful from the physics/business perspective # noqa: E501
- Returns
The key of this MaterialPropertyParameter. # noqa: E501
- Return type
str
- property name¶
Gets the name of this MaterialPropertyParameter. # noqa: E501
Optional user facing name or label key for human identification # noqa: E501
- Returns
The name of this MaterialPropertyParameter. # noqa: E501
- Return type
str
- openapi_types = {'key': 'str', 'name': 'str', 'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this MaterialPropertyParameter. # noqa: E501
The parameter unit # noqa: E501
- Returns
The unit of this MaterialPropertyParameter. # noqa: E501
- Return type
str
simscale_sdk.models.material_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_response.MaterialResponse(id=None, material_group_id=None, name=None, created_at=None, modified_at=None, properties=None, metadata=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'id': 'id', 'material_group_id': 'materialGroupId', 'metadata': 'metadata', 'modified_at': 'modifiedAt', 'name': 'name', 'properties': 'properties'}¶
- property created_at¶
Gets the created_at of this MaterialResponse. # noqa: E501
The time the material was created. # noqa: E501
- Returns
The created_at of this MaterialResponse. # noqa: E501
- Return type
datetime
- property id¶
Gets the id of this MaterialResponse. # noqa: E501
The material unique identifier. # noqa: E501
- Returns
The id of this MaterialResponse. # noqa: E501
- Return type
str
- property material_group_id¶
Gets the material_group_id of this MaterialResponse. # noqa: E501
The material group unique identifier. # noqa: E501
- Returns
The material_group_id of this MaterialResponse. # noqa: E501
- Return type
str
- property metadata¶
Gets the metadata of this MaterialResponse. # noqa: E501
- Returns
The metadata of this MaterialResponse. # noqa: E501
- Return type
object
- property modified_at¶
Gets the modified_at of this MaterialResponse. # noqa: E501
The time the material was modified. # noqa: E501
- Returns
The modified_at of this MaterialResponse. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this MaterialResponse. # noqa: E501
The material name. # noqa: E501
- Returns
The name of this MaterialResponse. # noqa: E501
- Return type
str
- openapi_types = {'created_at': 'datetime', 'id': 'str', 'material_group_id': 'str', 'metadata': 'object', 'modified_at': 'datetime', 'name': 'str', 'properties': 'dict(str, OneOfMaterialProperty)'}¶
- property properties¶
Gets the properties of this MaterialResponse. # noqa: E501
The material properties. # noqa: E501
- Returns
The properties of this MaterialResponse. # noqa: E501
- Return type
dict(str, OneOfMaterialProperty)
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_update_operation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_update_operation.MaterialUpdateOperation(path=None, material_data=None, material_spec=None, reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'material_data': 'materialData', 'material_spec': 'materialSpec', 'path': 'path', 'reference': 'reference'}¶
- property material_data¶
Gets the material_data of this MaterialUpdateOperation. # noqa: E501
- Returns
The material_data of this MaterialUpdateOperation. # noqa: E501
- Return type
- property material_spec¶
Gets the material_spec of this MaterialUpdateOperation. # noqa: E501
Material spec object that will be used as the base to apply the physical properties passed in materialData. # noqa: E501
- Returns
The material_spec of this MaterialUpdateOperation. # noqa: E501
- Return type
object
- openapi_types = {'material_data': 'MaterialResponse', 'material_spec': 'object', 'path': 'str', 'reference': 'MaterialUpdateOperationReference'}¶
- property path¶
Gets the path of this MaterialUpdateOperation. # noqa: E501
JSON pointer (considering the model field as root) specifying where to add the material. If it points to a container (e.g. /materials or /materials/solids), the material will be added to that container. If it points to an existing material instead (e.g. /materials/0 or /materials/solids/0), the new material will replace the one the pointer points to. # noqa: E501
- Returns
The path of this MaterialUpdateOperation. # noqa: E501
- Return type
str
- property reference¶
Gets the reference of this MaterialUpdateOperation. # noqa: E501
- Returns
The reference of this MaterialUpdateOperation. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_update_operation_reference module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_update_operation_reference.MaterialUpdateOperationReference(material_group_id=None, material_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'material_group_id': 'materialGroupId', 'material_id': 'materialId'}¶
- property material_group_id¶
Gets the material_group_id of this MaterialUpdateOperationReference. # noqa: E501
Identifier of the material group # noqa: E501
- Returns
The material_group_id of this MaterialUpdateOperationReference. # noqa: E501
- Return type
str
- property material_id¶
Gets the material_id of this MaterialUpdateOperationReference. # noqa: E501
Identifier of the material # noqa: E501
- Returns
The material_id of this MaterialUpdateOperationReference. # noqa: E501
- Return type
str
- openapi_types = {'material_group_id': 'str', 'material_id': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_update_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_update_request.MaterialUpdateRequest(operations=None, interpolation_parameters=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'interpolation_parameters': 'interpolationParameters', 'operations': 'operations'}¶
- property interpolation_parameters¶
Gets the interpolation_parameters of this MaterialUpdateRequest. # noqa: E501
Parameters taken into account when some material property values need to be interpolated. When this object is part of a request, the parameters will be taken into account during interpolation, while when it’s part of the response, the parameters show the values which were used (if any) during the interpolation. Note that the values used during interpolation might differ from what is requested. # noqa: E501
- Returns
The interpolation_parameters of this MaterialUpdateRequest. # noqa: E501
- Return type
dict(str, object)
- openapi_types = {'interpolation_parameters': 'dict(str, object)', 'operations': 'list[MaterialUpdateOperation]'}¶
- property operations¶
Gets the operations of this MaterialUpdateRequest. # noqa: E501
- Returns
The operations of this MaterialUpdateRequest. # noqa: E501
- Return type
list[MaterialUpdateOperation]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.material_update_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.material_update_response.MaterialUpdateResponse(spec=None, tables=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'spec': 'spec', 'tables': 'tables'}¶
- openapi_types = {'spec': 'SimulationSpec', 'tables': 'list[object]'}¶
- property spec¶
Gets the spec of this MaterialUpdateResponse. # noqa: E501
- Returns
The spec of this MaterialUpdateResponse. # noqa: E501
- Return type
- property tables¶
Gets the tables of this MaterialUpdateResponse. # noqa: E501
Tables containing parametric values, created during the material update operation(s). These tables are going to be used by the solvers during the simulation runs. # noqa: E501
- Returns
The tables of this MaterialUpdateResponse. # noqa: E501
- Return type
list[object]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.maximum_number_iteration_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.maximum_number_iteration_control.MaximumNumberIterationControl(type='MAXIMUM_NUMBER', max_num_iteration=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_num_iteration': 'maxNumIteration', 'type': 'type'}¶
- property max_num_iteration¶
Gets the max_num_iteration of this MaximumNumberIterationControl. # noqa: E501
- Returns
The max_num_iteration of this MaximumNumberIterationControl. # noqa: E501
- Return type
int
- openapi_types = {'max_num_iteration': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MaximumNumberIterationControl. # noqa: E501
Schema name: MaximumNumberIterationControl # noqa: E501
- Returns
The type of this MaximumNumberIterationControl. # noqa: E501
- Return type
str
simscale_sdk.models.mean_value_outlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mean_value_outlet_vbc.MeanValueOutletVBC(type='MEAN_VALUE_OUTLET_VELOCITY', normal_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'normal_velocity': 'normalVelocity', 'type': 'type'}¶
- property normal_velocity¶
Gets the normal_velocity of this MeanValueOutletVBC. # noqa: E501
- Returns
The normal_velocity of this MeanValueOutletVBC. # noqa: E501
- Return type
- openapi_types = {'normal_velocity': 'DimensionalFunctionSpeed', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MeanValueOutletVBC. # noqa: E501
Schema name: MeanValueOutletVBC # noqa: E501
- Returns
The type of this MeanValueOutletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.mean_value_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mean_value_pbc.MeanValuePBC(type='FIXED_MEAN', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalPressure'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MeanValuePBC. # noqa: E501
Schema name: MeanValuePBC # noqa: E501
- Returns
The type of this MeanValuePBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this MeanValuePBC. # noqa: E501
- Returns
The value of this MeanValuePBC. # noqa: E501
- Return type
simscale_sdk.models.mean_value_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mean_value_vbc.MeanValueVBC(type='FIXED_MEAN', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalVectorSpeed'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MeanValueVBC. # noqa: E501
Schema name: MeanValueVBC # noqa: E501
- Returns
The type of this MeanValueVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this MeanValueVBC. # noqa: E501
- Returns
The value of this MeanValueVBC. # noqa: E501
- Return type
simscale_sdk.models.mesh module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mesh.Mesh(mesh_id=None, name=None, created_at=None, number_of_cells=None, number_of_nodes=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'mesh_id': 'meshId', 'name': 'name', 'number_of_cells': 'numberOfCells', 'number_of_nodes': 'numberOfNodes'}¶
- property created_at¶
Gets the created_at of this Mesh. # noqa: E501
The time when the mesh was imported. # noqa: E501
- Returns
The created_at of this Mesh. # noqa: E501
- Return type
datetime
- property mesh_id¶
Gets the mesh_id of this Mesh. # noqa: E501
The ID of the mesh. # noqa: E501
- Returns
The mesh_id of this Mesh. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Mesh. # noqa: E501
The name of the mesh. # noqa: E501
- Returns
The name of this Mesh. # noqa: E501
- Return type
str
- property number_of_cells¶
Gets the number_of_cells of this Mesh. # noqa: E501
Number of cells of the mesh. # noqa: E501
- Returns
The number_of_cells of this Mesh. # noqa: E501
- Return type
int
- property number_of_nodes¶
Gets the number_of_nodes of this Mesh. # noqa: E501
Number of nodes of the mesh. # noqa: E501
- Returns
The number_of_nodes of this Mesh. # noqa: E501
- Return type
int
- openapi_types = {'created_at': 'datetime', 'mesh_id': 'str', 'name': 'str', 'number_of_cells': 'int', 'number_of_nodes': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.mesh_operation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mesh_operation.MeshOperation(mesh_operation_id=None, name=None, version='0.5', geometry_id=None, model=None, created_at=None, modified_at=None, started_at=None, finished_at=None, compute_resource=None, status=None, progress=None, mesh_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'compute_resource': 'computeResource', 'created_at': 'createdAt', 'finished_at': 'finishedAt', 'geometry_id': 'geometryId', 'mesh_id': 'meshId', 'mesh_operation_id': 'meshOperationId', 'model': 'model', 'modified_at': 'modifiedAt', 'name': 'name', 'progress': 'progress', 'started_at': 'startedAt', 'status': 'status', 'version': 'version'}¶
- property compute_resource¶
Gets the compute_resource of this MeshOperation. # noqa: E501
- Returns
The compute_resource of this MeshOperation. # noqa: E501
- Return type
- property created_at¶
Gets the created_at of this MeshOperation. # noqa: E501
The time the mesh operation was created. # noqa: E501
- Returns
The created_at of this MeshOperation. # noqa: E501
- Return type
datetime
- property finished_at¶
Gets the finished_at of this MeshOperation. # noqa: E501
The time the mesh operation was finished. # noqa: E501
- Returns
The finished_at of this MeshOperation. # noqa: E501
- Return type
datetime
- property geometry_id¶
Gets the geometry_id of this MeshOperation. # noqa: E501
The geometry ID of the mesh operation. # noqa: E501
- Returns
The geometry_id of this MeshOperation. # noqa: E501
- Return type
str
- property mesh_id¶
Gets the mesh_id of this MeshOperation. # noqa: E501
The ID of the generated mesh. # noqa: E501
- Returns
The mesh_id of this MeshOperation. # noqa: E501
- Return type
str
- property mesh_operation_id¶
Gets the mesh_operation_id of this MeshOperation. # noqa: E501
The mesh operation ID. # noqa: E501
- Returns
The mesh_operation_id of this MeshOperation. # noqa: E501
- Return type
str
- property model¶
Gets the model of this MeshOperation. # noqa: E501
- Returns
The model of this MeshOperation. # noqa: E501
- Return type
- property modified_at¶
Gets the modified_at of this MeshOperation. # noqa: E501
The time the mesh operation was last modified. # noqa: E501
- Returns
The modified_at of this MeshOperation. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this MeshOperation. # noqa: E501
The name of the mesh operation. # noqa: E501
- Returns
The name of this MeshOperation. # noqa: E501
- Return type
str
- openapi_types = {'compute_resource': 'MeshOperationComputeResource', 'created_at': 'datetime', 'finished_at': 'datetime', 'geometry_id': 'str', 'mesh_id': 'str', 'mesh_operation_id': 'str', 'model': 'Algorithm', 'modified_at': 'datetime', 'name': 'str', 'progress': 'float', 'started_at': 'datetime', 'status': 'Status', 'version': 'str'}¶
- property progress¶
Gets the progress of this MeshOperation. # noqa: E501
The current progress while the mesh operation is in progress. # noqa: E501
- Returns
The progress of this MeshOperation. # noqa: E501
- Return type
float
- property started_at¶
Gets the started_at of this MeshOperation. # noqa: E501
The time the mesh operation was started. # noqa: E501
- Returns
The started_at of this MeshOperation. # noqa: E501
- Return type
datetime
- property status¶
Gets the status of this MeshOperation. # noqa: E501
- Returns
The status of this MeshOperation. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property version¶
Gets the version of this MeshOperation. # noqa: E501
- Returns
The version of this MeshOperation. # noqa: E501
- Return type
str
simscale_sdk.models.mesh_operation_compute_resource module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mesh_operation_compute_resource.MeshOperationComputeResource(type=None, value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'ComputeResourceType', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MeshOperationComputeResource. # noqa: E501
- Returns
The type of this MeshOperationComputeResource. # noqa: E501
- Return type
- property value¶
Gets the value of this MeshOperationComputeResource. # noqa: E501
- Returns
The value of this MeshOperationComputeResource. # noqa: E501
- Return type
float
simscale_sdk.models.mesh_operations module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mesh_operations.MeshOperations(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this MeshOperations. # noqa: E501
- Returns
The embedded of this MeshOperations. # noqa: E501
- Return type
list[MeshOperation]
- property links¶
Gets the links of this MeshOperations. # noqa: E501
- Returns
The links of this MeshOperations. # noqa: E501
- Return type
- property meta¶
Gets the meta of this MeshOperations. # noqa: E501
- Returns
The meta of this MeshOperations. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[MeshOperation]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.mesh_quality_controls module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mesh_quality_controls.MeshQualityControls(max_non_orthogonality=None, max_boundary_skewness=None, max_internal_skewness=None, max_concaveness=None, min_volume=None, min_tet_quality=None, min_face_area=None, min_face_twist=None, min_determinant=None, min_face_weight=None, min_volume_ratio=None, min_triangle_twist=None, error_distribution_iterations=None, error_reduction=None, relaxed_max_non_orthogonality=None, merge_tolerance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'error_distribution_iterations': 'errorDistributionIterations', 'error_reduction': 'errorReduction', 'max_boundary_skewness': 'maxBoundarySkewness', 'max_concaveness': 'maxConcaveness', 'max_internal_skewness': 'maxInternalSkewness', 'max_non_orthogonality': 'maxNonOrthogonality', 'merge_tolerance': 'mergeTolerance', 'min_determinant': 'minDeterminant', 'min_face_area': 'minFaceArea', 'min_face_twist': 'minFaceTwist', 'min_face_weight': 'minFaceWeight', 'min_tet_quality': 'minTetQuality', 'min_triangle_twist': 'minTriangleTwist', 'min_volume': 'minVolume', 'min_volume_ratio': 'minVolumeRatio', 'relaxed_max_non_orthogonality': 'relaxedMaxNonOrthogonality'}¶
- property error_distribution_iterations¶
Gets the error_distribution_iterations of this MeshQualityControls. # noqa: E501
<p>Define the number of error distribution iterations.</p> # noqa: E501
- Returns
The error_distribution_iterations of this MeshQualityControls. # noqa: E501
- Return type
int
- property error_reduction¶
Gets the error_reduction of this MeshQualityControls. # noqa: E501
<p>This parameter specifies how much the displacement is scaled at error locations.</p> # noqa: E501
- Returns
The error_reduction of this MeshQualityControls. # noqa: E501
- Return type
float
- property max_boundary_skewness¶
Gets the max_boundary_skewness of this MeshQualityControls. # noqa: E501
- Returns
The max_boundary_skewness of this MeshQualityControls. # noqa: E501
- Return type
- property max_concaveness¶
Gets the max_concaveness of this MeshQualityControls. # noqa: E501
- Returns
The max_concaveness of this MeshQualityControls. # noqa: E501
- Return type
- property max_internal_skewness¶
Gets the max_internal_skewness of this MeshQualityControls. # noqa: E501
- Returns
The max_internal_skewness of this MeshQualityControls. # noqa: E501
- Return type
- property max_non_orthogonality¶
Gets the max_non_orthogonality of this MeshQualityControls. # noqa: E501
- Returns
The max_non_orthogonality of this MeshQualityControls. # noqa: E501
- Return type
- property merge_tolerance¶
Gets the merge_tolerance of this MeshQualityControls. # noqa: E501
<p>This parameters specifies the accuracy of face merging as a fraction of the initial bounding box.</p> # noqa: E501
- Returns
The merge_tolerance of this MeshQualityControls. # noqa: E501
- Return type
float
- property min_determinant¶
Gets the min_determinant of this MeshQualityControls. # noqa: E501
<p>Define the minimum normalised cell determinant. Choose a value between 0 and 1. Hex corresponds to 1.</p> # noqa: E501
- Returns
The min_determinant of this MeshQualityControls. # noqa: E501
- Return type
float
- property min_face_area¶
Gets the min_face_area of this MeshQualityControls. # noqa: E501
- Returns
The min_face_area of this MeshQualityControls. # noqa: E501
- Return type
- property min_face_twist¶
Gets the min_face_twist of this MeshQualityControls. # noqa: E501
<p>Define the minimum cosine of face twist allowed (see documentation). Set to a value smaller than -1 to disable. The value results from the dot product of the face normal and the face centre triangles normal.</p> # noqa: E501
- Returns
The min_face_twist of this MeshQualityControls. # noqa: E501
- Return type
float
- property min_face_weight¶
Gets the min_face_weight of this MeshQualityControls. # noqa: E501
<p>The face weight specifies the distribution of a face’s contribution to its two neighbouring cells. A very small face weight would mean that the neighbouring cells are disproportionately different in size. Choose a value between 0 and 0.5. 0.5 refers to a face with neighbouring cells of the same size.</p> # noqa: E501
- Returns
The min_face_weight of this MeshQualityControls. # noqa: E501
- Return type
float
- property min_tet_quality¶
Gets the min_tet_quality of this MeshQualityControls. # noqa: E501
<p>Define a minimum tetrahedron quality for cells (see documentation). Choose a low negative number to disable this check, e.g. -1e30.</p> # noqa: E501
- Returns
The min_tet_quality of this MeshQualityControls. # noqa: E501
- Return type
float
- property min_triangle_twist¶
Gets the min_triangle_twist of this MeshQualityControls. # noqa: E501
<p>Same as Min Face Twist, but for adjacent triangular faces (see documentation). Choose a value below -1 to disable this feature.</p> # noqa: E501
- Returns
The min_triangle_twist of this MeshQualityControls. # noqa: E501
- Return type
float
- property min_volume¶
Gets the min_volume of this MeshQualityControls. # noqa: E501
- Returns
The min_volume of this MeshQualityControls. # noqa: E501
- Return type
- property min_volume_ratio¶
Gets the min_volume_ratio of this MeshQualityControls. # noqa: E501
<p>This parameter specifies the minimum allowed volume ratio between two adjacent cells. Choose a value between 0 and 1. 1 means that the neighbouring cells have the same volume.</p> # noqa: E501
- Returns
The min_volume_ratio of this MeshQualityControls. # noqa: E501
- Return type
float
- openapi_types = {'error_distribution_iterations': 'int', 'error_reduction': 'float', 'max_boundary_skewness': 'DimensionalAngle', 'max_concaveness': 'DimensionalAngle', 'max_internal_skewness': 'DimensionalAngle', 'max_non_orthogonality': 'DimensionalAngle', 'merge_tolerance': 'float', 'min_determinant': 'float', 'min_face_area': 'DimensionalArea', 'min_face_twist': 'float', 'min_face_weight': 'float', 'min_tet_quality': 'float', 'min_triangle_twist': 'float', 'min_volume': 'DimensionalVolume', 'min_volume_ratio': 'float', 'relaxed_max_non_orthogonality': 'DimensionalAngle'}¶
- property relaxed_max_non_orthogonality¶
Gets the relaxed_max_non_orthogonality of this MeshQualityControls. # noqa: E501
- Returns
The relaxed_max_non_orthogonality of this MeshQualityControls. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.meshes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.meshes.Meshes(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this Meshes. # noqa: E501
- Returns
The embedded of this Meshes. # noqa: E501
- Return type
list[Mesh]
- property links¶
Gets the links of this Meshes. # noqa: E501
- Returns
The links of this Meshes. # noqa: E501
- Return type
- property meta¶
Gets the meta of this Meshes. # noqa: E501
- Returns
The meta of this Meshes. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[Mesh]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.min_max_fields_calculation_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.min_max_fields_calculation_result_control_item.MinMaxFieldsCalculationResultControlItem(type='MIN_MAX_FIELDS_CALCULATION', name=None, field_selection=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_selection': 'fieldSelection', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property field_selection¶
Gets the field_selection of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Returns
The field_selection of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Return type
OneOfMinMaxFieldsCalculationResultControlItemFieldSelection
- property name¶
Gets the name of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Returns
The name of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'field_selection': 'OneOfMinMaxFieldsCalculationResultControlItemFieldSelection', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Returns
The topological_reference of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Return type
- property type¶
Gets the type of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
Schema name: MinMaxFieldsCalculationResultControlItem # noqa: E501
- Returns
The type of this MinMaxFieldsCalculationResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.mixed_timestep_calculation_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mixed_timestep_calculation_type.MixedTimestepCalculationType(type='MIXED', fixed_subdivision=None, adaptive_augmentation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property adaptive_augmentation¶
Gets the adaptive_augmentation of this MixedTimestepCalculationType. # noqa: E501
- Returns
The adaptive_augmentation of this MixedTimestepCalculationType. # noqa: E501
- Return type
- attribute_map = {'adaptive_augmentation': 'adaptiveAugmentation', 'fixed_subdivision': 'fixedSubdivision', 'type': 'type'}¶
- property fixed_subdivision¶
Gets the fixed_subdivision of this MixedTimestepCalculationType. # noqa: E501
- Returns
The fixed_subdivision of this MixedTimestepCalculationType. # noqa: E501
- Return type
- openapi_types = {'adaptive_augmentation': 'AdaptiveAugmentation', 'fixed_subdivision': 'FixedSubdivision', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MixedTimestepCalculationType. # noqa: E501
<p>Select how the time increments should be computed in case of an adaptation event. Currently four types are available (which may not all be available for every event):</p><ul><li><p><b>Manual</b>: Here the user defines fixed time step subdivision and augmentation settings.</p></ul><ul><li><p><b>Newton Iterations Target</b>: With this setting the user defines a target value for the Newton Iterations and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Field Change Target</b>: With this setting the user defines a target value for change of a specific field component within a time increment and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Mixed</b>: The mixed type uses a fixed subdivision and an automatic adaptation of the time step with a target value for the change of the selected field component.</p></ul> Schema name: MixedTimestepCalculationType # noqa: E501
- Returns
The type of this MixedTimestepCalculationType. # noqa: E501
- Return type
str
simscale_sdk.models.mixing_length_inlet_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mixing_length_inlet_ebc.MixingLengthInletEBC(type='TURBULENCE_MIXING_LENGTH_DISSIPATION_RATE_INLET', mixing_length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mixing_length': 'mixingLength', 'type': 'type'}¶
- property mixing_length¶
Gets the mixing_length of this MixingLengthInletEBC. # noqa: E501
- Returns
The mixing_length of this MixingLengthInletEBC. # noqa: E501
- Return type
- openapi_types = {'mixing_length': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MixingLengthInletEBC. # noqa: E501
Schema name: MixingLengthInletEBC # noqa: E501
- Returns
The type of this MixingLengthInletEBC. # noqa: E501
- Return type
str
simscale_sdk.models.model_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.model_settings.ModelSettings(parts=None, hide_selected_parts=False, show_volumes=None, scalar_field=None, scalar_settings=None, vector_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'hide_selected_parts': 'hideSelectedParts', 'parts': 'parts', 'scalar_field': 'scalarField', 'scalar_settings': 'scalarSettings', 'show_volumes': 'showVolumes', 'vector_settings': 'vectorSettings'}¶
- property hide_selected_parts¶
Gets the hide_selected_parts of this ModelSettings. # noqa: E501
If set to true, the parts array indicates the hidden parts, while the rest of the model parts are visible (blacklist). On the other hand, if set to false, then the parts array indicate the visible parts while the rest of the model parts are hidden (whitelist). If the parts array is empty, then setting this value to true will hide all the model parts, while setting it to false will show all the model parts. # noqa: E501
- Returns
The hide_selected_parts of this ModelSettings. # noqa: E501
- Return type
bool
- openapi_types = {'hide_selected_parts': 'bool', 'parts': 'list[Part]', 'scalar_field': 'ScalarField', 'scalar_settings': 'list[ScalarSettings]', 'show_volumes': 'bool', 'vector_settings': 'list[VectorSettings]'}¶
- property parts¶
Gets the parts of this ModelSettings. # noqa: E501
The parts to show or hide in the report (see hideSelectedParts). # noqa: E501
- Returns
The parts of this ModelSettings. # noqa: E501
- Return type
list[Part]
- property scalar_field¶
Gets the scalar_field of this ModelSettings. # noqa: E501
- Returns
The scalar_field of this ModelSettings. # noqa: E501
- Return type
- property scalar_settings¶
Gets the scalar_settings of this ModelSettings. # noqa: E501
- Returns
The scalar_settings of this ModelSettings. # noqa: E501
- Return type
list[ScalarSettings]
- property show_volumes¶
Gets the show_volumes of this ModelSettings. # noqa: E501
If set to false, then volumes will be hidden unless they are mentioned explicitly, i.e. when a volume is included in the parts array, and hideSelectedParts is set to false. # noqa: E501
- Returns
The show_volumes of this ModelSettings. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vector_settings¶
Gets the vector_settings of this ModelSettings. # noqa: E501
The settings for the different vectors of the model. # noqa: E501
- Returns
The vector_settings of this ModelSettings. # noqa: E501
- Return type
list[VectorSettings]
simscale_sdk.models.moderate_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.moderate_resolution.ModerateResolution(type='MODERATE_RESOLUTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ModerateResolution. # noqa: E501
Output will be written every 4 time steps. Schema name: ModerateResolution # noqa: E501
- Returns
The type of this ModerateResolution. # noqa: E501
- Return type
str
simscale_sdk.models.moment_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.moment_field_selection.MomentFieldSelection(type='MOMENT', moment_type=None, reference_point=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'moment_type': 'momentType', 'reference_point': 'referencePoint', 'type': 'type'}¶
- property moment_type¶
Gets the moment_type of this MomentFieldSelection. # noqa: E501
- Returns
The moment_type of this MomentFieldSelection. # noqa: E501
- Return type
OneOfMomentFieldSelectionMomentType
- openapi_types = {'moment_type': 'OneOfMomentFieldSelectionMomentType', 'reference_point': 'DimensionalVectorLength', 'type': 'str'}¶
- property reference_point¶
Gets the reference_point of this MomentFieldSelection. # noqa: E501
- Returns
The reference_point of this MomentFieldSelection. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MomentFieldSelection. # noqa: E501
Schema name: MomentFieldSelection # noqa: E501
- Returns
The type of this MomentFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.mooney_rivlin_hyper_elastic_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mooney_rivlin_hyper_elastic_model.MooneyRivlinHyperElasticModel(type='MOONEY_RIVLIN', c10=None, c01=None, d1=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'c01': 'c01', 'c10': 'c10', 'd1': 'd1', 'type': 'type'}¶
- property c01¶
Gets the c01 of this MooneyRivlinHyperElasticModel. # noqa: E501
- Returns
The c01 of this MooneyRivlinHyperElasticModel. # noqa: E501
- Return type
- property c10¶
Gets the c10 of this MooneyRivlinHyperElasticModel. # noqa: E501
- Returns
The c10 of this MooneyRivlinHyperElasticModel. # noqa: E501
- Return type
- property d1¶
Gets the d1 of this MooneyRivlinHyperElasticModel. # noqa: E501
- Returns
The d1 of this MooneyRivlinHyperElasticModel. # noqa: E501
- Return type
- openapi_types = {'c01': 'DimensionalPressure', 'c10': 'DimensionalPressure', 'd1': 'DimensionalInvPressure', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MooneyRivlinHyperElasticModel. # noqa: E501
<p>Choose the hyperelastic material model that should be used. All models derive the stress-strain relation from a strain energy function defined by the material model parameters.</p> Schema name: MooneyRivlinHyperElasticModel # noqa: E501
- Returns
The type of this MooneyRivlinHyperElasticModel. # noqa: E501
- Return type
str
simscale_sdk.models.moving_wall_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.moving_wall_vbc.MovingWallVBC(type='MOVING_WALL_VELOCITY', value=None, turbulence_wall=None, orientation_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'orientation_reference': 'orientationReference', 'turbulence_wall': 'turbulenceWall', 'type': 'type', 'value': 'value'}¶
- openapi_types = {'orientation_reference': 'str', 'turbulence_wall': 'str', 'type': 'str', 'value': 'DimensionalVectorSpeed'}¶
- property orientation_reference¶
Gets the orientation_reference of this MovingWallVBC. # noqa: E501
- Returns
The orientation_reference of this MovingWallVBC. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_wall¶
Gets the turbulence_wall of this MovingWallVBC. # noqa: E501
- Returns
The turbulence_wall of this MovingWallVBC. # noqa: E501
- Return type
str
- property type¶
Gets the type of this MovingWallVBC. # noqa: E501
Schema name: MovingWallVBC # noqa: E501
- Returns
The type of this MovingWallVBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this MovingWallVBC. # noqa: E501
- Returns
The value of this MovingWallVBC. # noqa: E501
- Return type
simscale_sdk.models.mrf_rotating_zone module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mrf_rotating_zone.MRFRotatingZone(type='MULTI_REFERENCE_FRAME', name=None, origin=None, axis=None, angular_velocity=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property angular_velocity¶
Gets the angular_velocity of this MRFRotatingZone. # noqa: E501
- Returns
The angular_velocity of this MRFRotatingZone. # noqa: E501
- Return type
- attribute_map = {'angular_velocity': 'angularVelocity', 'axis': 'axis', 'name': 'name', 'origin': 'origin', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property axis¶
Gets the axis of this MRFRotatingZone. # noqa: E501
- Returns
The axis of this MRFRotatingZone. # noqa: E501
- Return type
- property name¶
Gets the name of this MRFRotatingZone. # noqa: E501
- Returns
The name of this MRFRotatingZone. # noqa: E501
- Return type
str
- openapi_types = {'angular_velocity': 'DimensionalFunctionRotationSpeed', 'axis': 'DimensionalVectorLength', 'name': 'str', 'origin': 'DimensionalVectorLength', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property origin¶
Gets the origin of this MRFRotatingZone. # noqa: E501
- Returns
The origin of this MRFRotatingZone. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this MRFRotatingZone. # noqa: E501
- Returns
The topological_reference of this MRFRotatingZone. # noqa: E501
- Return type
- property type¶
Gets the type of this MRFRotatingZone. # noqa: E501
Schema name: MRFRotatingZone # noqa: E501
- Returns
The type of this MRFRotatingZone. # noqa: E501
- Return type
str
simscale_sdk.models.mules_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mules_solver.MULESSolver(type='MULES_V7', alpha_correctors=None, alpha_sub_cycles=None, compression_coefficient=None, isotropic_compression_coefficient=None, semi_implicit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property alpha_correctors¶
Gets the alpha_correctors of this MULESSolver. # noqa: E501
- Returns
The alpha_correctors of this MULESSolver. # noqa: E501
- Return type
int
- property alpha_sub_cycles¶
Gets the alpha_sub_cycles of this MULESSolver. # noqa: E501
- Returns
The alpha_sub_cycles of this MULESSolver. # noqa: E501
- Return type
int
- attribute_map = {'alpha_correctors': 'alphaCorrectors', 'alpha_sub_cycles': 'alphaSubCycles', 'compression_coefficient': 'compressionCoefficient', 'isotropic_compression_coefficient': 'isotropicCompressionCoefficient', 'semi_implicit': 'semiImplicit', 'type': 'type'}¶
- property compression_coefficient¶
Gets the compression_coefficient of this MULESSolver. # noqa: E501
- Returns
The compression_coefficient of this MULESSolver. # noqa: E501
- Return type
float
- property isotropic_compression_coefficient¶
Gets the isotropic_compression_coefficient of this MULESSolver. # noqa: E501
- Returns
The isotropic_compression_coefficient of this MULESSolver. # noqa: E501
- Return type
float
- openapi_types = {'alpha_correctors': 'int', 'alpha_sub_cycles': 'int', 'compression_coefficient': 'float', 'isotropic_compression_coefficient': 'float', 'semi_implicit': 'OneOfMULESSolverSemiImplicit', 'type': 'str'}¶
- property semi_implicit¶
Gets the semi_implicit of this MULESSolver. # noqa: E501
- Returns
The semi_implicit of this MULESSolver. # noqa: E501
- Return type
OneOfMULESSolverSemiImplicit
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MULESSolver. # noqa: E501
Schema name: MULESSolver # noqa: E501
- Returns
The type of this MULESSolver. # noqa: E501
- Return type
str
simscale_sdk.models.multifrontal_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.multifrontal_solver.MultifrontalSolver(type='MULTIFRONT', renumbering_method=None, force_symmetric=None, precision_singularity_detection=None, stop_if_singular=None, eliminate_lagrange_multipliers=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'eliminate_lagrange_multipliers': 'eliminateLagrangeMultipliers', 'force_symmetric': 'forceSymmetric', 'precision_singularity_detection': 'precisionSingularityDetection', 'renumbering_method': 'renumberingMethod', 'stop_if_singular': 'stopIfSingular', 'type': 'type'}¶
- property eliminate_lagrange_multipliers¶
Gets the eliminate_lagrange_multipliers of this MultifrontalSolver. # noqa: E501
This option makes it possible to eliminate the Lagrange Multipliers which are introduced by generalized boundary conditions like bonded contact, remote boundary conditions and symmetry conditions. If activated, this option removes the Lagrange Multipliers which leads to a reduction of the total number of unknowns and can increase the robustness of iterative solvers. # noqa: E501
- Returns
The eliminate_lagrange_multipliers of this MultifrontalSolver. # noqa: E501
- Return type
bool
- property force_symmetric¶
Gets the force_symmetric of this MultifrontalSolver. # noqa: E501
Choose if you want to enforce a symmetric matrix. # noqa: E501
- Returns
The force_symmetric of this MultifrontalSolver. # noqa: E501
- Return type
bool
- openapi_types = {'eliminate_lagrange_multipliers': 'bool', 'force_symmetric': 'bool', 'precision_singularity_detection': 'int', 'renumbering_method': 'str', 'stop_if_singular': 'bool', 'type': 'str'}¶
- property precision_singularity_detection¶
Gets the precision_singularity_detection of this MultifrontalSolver. # noqa: E501
Define the precision value for the detection of a singular matrix. # noqa: E501
- Returns
The precision_singularity_detection of this MultifrontalSolver. # noqa: E501
- Return type
int
- property renumbering_method¶
Gets the renumbering_method of this MultifrontalSolver. # noqa: E501
Choose a renumbering method for the solution process.<br/>For large models around and above 50000 degrees of freedom you should consider using MDA. # noqa: E501
- Returns
The renumbering_method of this MultifrontalSolver. # noqa: E501
- Return type
str
- property stop_if_singular¶
Gets the stop_if_singular of this MultifrontalSolver. # noqa: E501
Choose if the calculation should be stopped if the problem turns out to be singular. # noqa: E501
- Returns
The stop_if_singular of this MultifrontalSolver. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MultifrontalSolver. # noqa: E501
<p>Choose a linear equation system solver for your calculation:</p><ul><li><p><b>Multfront</b> is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.</p></ul><ul><li><p><b>MUMPS</b> is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.</p></ul><ul><li><p><b>LDLT</b> is a direct solver which uses a Gaussian Algortihm. It is comparatively slow for big problems.</p></ul><ul><li><p><b>PETSC</b> is an iterative solver specially designed to deal with large systems. It scales very effectively in parallel and is the best choice for large problems.</p></ul><ul><li><p><b>GCPC</b> is an iterative solver of the pre-conditioned conjugate gradient type. It scales well in parallel and is also usable for large problems.</p></ul> Schema name: MultifrontalSolver # noqa: E501
- Returns
The type of this MultifrontalSolver. # noqa: E501
- Return type
str
simscale_sdk.models.multiphase module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.multiphase.Multiphase(type='MULTIPHASE', use_local_time_stepping=None, turbulence_model=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, advanced_concepts=None, numerics=None, simulation_control=None, result_control=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this Multiphase. # noqa: E501
- Returns
The advanced_concepts of this Multiphase. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'model': 'model', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'turbulence_model': 'turbulenceModel', 'type': 'type', 'use_local_time_stepping': 'useLocalTimeStepping'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this Multiphase. # noqa: E501
- Returns
The boundary_conditions of this Multiphase. # noqa: E501
- Return type
list[OneOfMultiphaseBoundaryConditions]
- property initial_conditions¶
Gets the initial_conditions of this Multiphase. # noqa: E501
- Returns
The initial_conditions of this Multiphase. # noqa: E501
- Return type
- property materials¶
Gets the materials of this Multiphase. # noqa: E501
- Returns
The materials of this Multiphase. # noqa: E501
- Return type
- property model¶
Gets the model of this Multiphase. # noqa: E501
- Returns
The model of this Multiphase. # noqa: E501
- Return type
- property numerics¶
Gets the numerics of this Multiphase. # noqa: E501
- Returns
The numerics of this Multiphase. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfMultiphaseBoundaryConditions]', 'initial_conditions': 'FluidInitialConditions', 'materials': 'IncompressibleFluidMaterials', 'model': 'FluidModel', 'numerics': 'FluidNumerics', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'turbulence_model': 'str', 'type': 'str', 'use_local_time_stepping': 'bool'}¶
- property result_control¶
Gets the result_control of this Multiphase. # noqa: E501
- Returns
The result_control of this Multiphase. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this Multiphase. # noqa: E501
- Returns
The simulation_control of this Multiphase. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this Multiphase. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a>, <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-omega-sst/’ target=’_blank’>k-omega and k-omega SST</a></li><li><strong>LES</strong>: Smagorinsky, Spalart-Allmaras</li></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this Multiphase. # noqa: E501
- Return type
str
- property type¶
Gets the type of this Multiphase. # noqa: E501
Schema name: Multiphase # noqa: E501
- Returns
The type of this Multiphase. # noqa: E501
- Return type
str
- property use_local_time_stepping¶
Gets the use_local_time_stepping of this Multiphase. # noqa: E501
With the <i>Local time stepping</i> option enabled, it’s possible to accelerate the simulation towards a steady-state. As a result, faster computing times and smaller result data size. Commonly used in ship hull resistance analysis. # noqa: E501
- Returns
The use_local_time_stepping of this Multiphase. # noqa: E501
- Return type
bool
simscale_sdk.models.multiple_errors_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.multiple_errors_response.MultipleErrorsResponse(severity=None, entries=None, trace=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'entries': 'entries', 'severity': 'severity', 'trace': 'trace'}¶
- property entries¶
Gets the entries of this MultipleErrorsResponse. # noqa: E501
- Returns
The entries of this MultipleErrorsResponse. # noqa: E501
- Return type
list[LogEntry]
- openapi_types = {'entries': 'list[LogEntry]', 'severity': 'LogSeverity', 'trace': 'str'}¶
- property severity¶
Gets the severity of this MultipleErrorsResponse. # noqa: E501
- Returns
The severity of this MultipleErrorsResponse. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property trace¶
Gets the trace of this MultipleErrorsResponse. # noqa: E501
- Returns
The trace of this MultipleErrorsResponse. # noqa: E501
- Return type
str
simscale_sdk.models.multiplied_slave_nodes_iteration_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.multiplied_slave_nodes_iteration_control.MultipliedSlaveNodesIterationControl(type='MULTIPLIED_SLAVE_NODE', multiple_value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'multiple_value': 'multipleValue', 'type': 'type'}¶
- property multiple_value¶
Gets the multiple_value of this MultipliedSlaveNodesIterationControl. # noqa: E501
- Returns
The multiple_value of this MultipliedSlaveNodesIterationControl. # noqa: E501
- Return type
int
- openapi_types = {'multiple_value': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MultipliedSlaveNodesIterationControl. # noqa: E501
Schema name: MultipliedSlaveNodesIterationControl # noqa: E501
- Returns
The type of this MultipliedSlaveNodesIterationControl. # noqa: E501
- Return type
str
simscale_sdk.models.mumps_preconditoner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mumps_preconditoner.MUMPSPreconditoner(type='MUMPS_LDLT', actualisation_rate=None, memory_percentage_for_pivoting=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property actualisation_rate¶
Gets the actualisation_rate of this MUMPSPreconditoner. # noqa: E501
Set the reactualisation intervall for the preconditioner matrix P. If this value is set to 30 the preconditioner is recomputed just every 30th iteration. This preconditioner is computionally more expensive than the incomplete LDLT factorization but nearer to the exact solution. This setting makes it possible to save computation time by taking advantage of this fact. # noqa: E501
- Returns
The actualisation_rate of this MUMPSPreconditoner. # noqa: E501
- Return type
int
- attribute_map = {'actualisation_rate': 'actualisationRate', 'memory_percentage_for_pivoting': 'memoryPercentageForPivoting', 'type': 'type'}¶
- property memory_percentage_for_pivoting¶
Gets the memory_percentage_for_pivoting of this MUMPSPreconditoner. # noqa: E501
Define how much additional memory should be reserved for the pivoting operations. If MUMPS estimates that the necessary space for factorising the matrix would be 100, choosing a value of 20 would mean that MUMPS allocates a memory space of 120. # noqa: E501
- Returns
The memory_percentage_for_pivoting of this MUMPSPreconditoner. # noqa: E501
- Return type
float
- openapi_types = {'actualisation_rate': 'int', 'memory_percentage_for_pivoting': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MUMPSPreconditoner. # noqa: E501
Schema name: MUMPSPreconditoner # noqa: E501
- Returns
The type of this MUMPSPreconditoner. # noqa: E501
- Return type
str
simscale_sdk.models.mumps_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.mumps_solver.MUMPSSolver(type='MUMPS', force_symmetric=None, precision_singularity_detection=None, stop_if_singular=None, matrix_type=None, memory_percentage_for_pivoting=None, linear_system_relative_residual=None, matrix_filtering_threshold=None, single_precision=None, preprocessing=None, renumbering_method=None, postprocessing=None, distributed_matrix_storage=None, memory_management=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distributed_matrix_storage': 'distributedMatrixStorage', 'force_symmetric': 'forceSymmetric', 'linear_system_relative_residual': 'linearSystemRelativeResidual', 'matrix_filtering_threshold': 'matrixFilteringThreshold', 'matrix_type': 'matrixType', 'memory_management': 'memoryManagement', 'memory_percentage_for_pivoting': 'memoryPercentageForPivoting', 'postprocessing': 'postprocessing', 'precision_singularity_detection': 'precisionSingularityDetection', 'preprocessing': 'preprocessing', 'renumbering_method': 'renumberingMethod', 'single_precision': 'singlePrecision', 'stop_if_singular': 'stopIfSingular', 'type': 'type'}¶
- property distributed_matrix_storage¶
Gets the distributed_matrix_storage of this MUMPSSolver. # noqa: E501
Choose this parameter as <b>true</b> to ensure that the system matrix saving is distributed among the processors of the computation. If multiple cores are used only the relevant part for each core is saved. If it is set to false the whole matrix is saved for each processor. This parameter has currently no effect for <i>Harmonic</i> simulations. # noqa: E501
- Returns
The distributed_matrix_storage of this MUMPSSolver. # noqa: E501
- Return type
bool
- property force_symmetric¶
Gets the force_symmetric of this MUMPSSolver. # noqa: E501
Choose if you want to enforce a symmetric matrix. # noqa: E501
- Returns
The force_symmetric of this MUMPSSolver. # noqa: E501
- Return type
bool
- property linear_system_relative_residual¶
Gets the linear_system_relative_residual of this MUMPSSolver. # noqa: E501
Choose a value for the maximum relative residual for each linear system resolution compared to the exact solution. In a nonlinear calculation the user can deactivate this check by selecting a negative value (for example, -1.0) since the quality of the solution is controlled within the Newton loop. # noqa: E501
- Returns
The linear_system_relative_residual of this MUMPSSolver. # noqa: E501
- Return type
float
- property matrix_filtering_threshold¶
Gets the matrix_filtering_threshold of this MUMPSSolver. # noqa: E501
This parameter allows a filtration of the matrix entries that are saved and possibly passed to the nonlinear algorithm (Newton) and is similar to a relaxation mechanism. If the given threshold value is strictly positive, MUMPS only saves the matrix entries that satisfy the following condition: |K<sub>ij</sub>| value*(|K<sub>ii</sub>|+|K<sub>jj</sub>|). Thus using this functionality might save computation time as well as memory consumption, but the effects strongly depend on the given value and is only advised for the experienced user. # noqa: E501
- Returns
The matrix_filtering_threshold of this MUMPSSolver. # noqa: E501
- Return type
float
- property matrix_type¶
Gets the matrix_type of this MUMPSSolver. # noqa: E501
<p>Choose the type of your system matrix by directly selecting the appropriate type or using the <b>automatic detection</b>. With the selection <b>automatic detection</b> the matrix type <b>symmetric positive indefinite</b> is selected if a symmetric system matrix is detected, and <b>asymmetric</b> otherwise. # noqa: E501
- Returns
The matrix_type of this MUMPSSolver. # noqa: E501
- Return type
str
- property memory_management¶
Gets the memory_management of this MUMPSSolver. # noqa: E501
Choose the memory managment priority of the MUMPS solver. If <b>in-core</b> is used the memory managment is optimized with respect to the calculation time by saving all objects in the RAM. If <b>out-of-core</b> is chosen, the memory managment is optimized for a minimal RAM usage. If <b>automatic</b> is selected, MUMPS choses automatically a reasonable memory managment mode. The option <b>memory demand evaluation</b> is helpful to estimate the RAM consumption. This estimate is written to the solver log file. In this case the solution process aborts after the memory usage is estimated, allowing the user to start a new run with the best settings. # noqa: E501
- Returns
The memory_management of this MUMPSSolver. # noqa: E501
- Return type
str
- property memory_percentage_for_pivoting¶
Gets the memory_percentage_for_pivoting of this MUMPSSolver. # noqa: E501
Define how much additional memory should be reserved for the pivoting operations. If MUMPS estimates that the necessary space for factorising the matrix would be 100, choosing a value of 20 would mean that MUMPS allocates a memory space of 120. # noqa: E501
- Returns
The memory_percentage_for_pivoting of this MUMPSSolver. # noqa: E501
- Return type
float
- openapi_types = {'distributed_matrix_storage': 'bool', 'force_symmetric': 'bool', 'linear_system_relative_residual': 'float', 'matrix_filtering_threshold': 'float', 'matrix_type': 'str', 'memory_management': 'str', 'memory_percentage_for_pivoting': 'float', 'postprocessing': 'str', 'precision_singularity_detection': 'int', 'preprocessing': 'bool', 'renumbering_method': 'str', 'single_precision': 'bool', 'stop_if_singular': 'bool', 'type': 'str'}¶
- property postprocessing¶
Gets the postprocessing of this MUMPSSolver. # noqa: E501
With this option the user can control the iterative refinement of the linear system solution. This option only has an effect if the value of the <b> linear system relative residual</b> given by the user is greater than zero, otherwise it is ignored. If it is <b>activate</b> MUMPS carries out at least one additional iteration of the linear system resolution and at most 10 iterations. The process is stopped if the residual isn’t reduced by at least a factor of 5. If this option is set to be <b>inactive</b> no additional iteration is done and if <b>automatic</b> is chosen MUMPS automatically decides if additional iterations should be done and the maximum number of iterations is set to 4. # noqa: E501
- Returns
The postprocessing of this MUMPSSolver. # noqa: E501
- Return type
str
- property precision_singularity_detection¶
Gets the precision_singularity_detection of this MUMPSSolver. # noqa: E501
Define the precision value for the detection of a singular matrix. # noqa: E501
- Returns
The precision_singularity_detection of this MUMPSSolver. # noqa: E501
- Return type
int
- property preprocessing¶
Gets the preprocessing of this MUMPSSolver. # noqa: E501
If this option is activated MUMPS performs a pre-processing on order to identify the best parameter setting for some internal parameters adapted to the current problem. # noqa: E501
- Returns
The preprocessing of this MUMPSSolver. # noqa: E501
- Return type
bool
- property renumbering_method¶
Gets the renumbering_method of this MUMPSSolver. # noqa: E501
Choose the renumbering method for the system matrix entries. The choice of the renumbering method has a big impact on the memory consumption and the solution time. Currently supported are:<ul><li><p><b>SCOTCH</b> is a powerful renumbering tool, suited for most scenarios and the standard choice for MUMPS.</p></ul><ul><li><p><b>PORD</b> is a renumbering tool that comes with MUMPS.</p></ul><ul><li><p><b>AMD</b> uses the <i>Approximate Minimum Degree</i> method.</p></ul><ul><li><p><b>AMF</b> uses the <i>Approximate Minimum Fill</i> method.</p></ul><ul><li><p><b>QAMD</b> is a variant of AMD with automatic detection of quasi-dense matrix lines.</p></ul>If <b>automatic</b> is selected the user let MUMPS choose the renumbering tool. The methods AMD, AMF and QAMD are generally inferior to the more sophisticated methods SCOTCH and PORD but may be a better choice in some cases. # noqa: E501
- Returns
The renumbering_method of this MUMPSSolver. # noqa: E501
- Return type
str
- property single_precision¶
Gets the single_precision of this MUMPSSolver. # noqa: E501
If this option is activated the matrix factorisation is done with single precision and thus a reduction in memory consumption (often about 50%) and computation time is gained if the problem is well conditioned. If the problem is ill-conditioned one risks that in a nonlinear computation the newton algorithm fails to converge. # noqa: E501
- Returns
The single_precision of this MUMPSSolver. # noqa: E501
- Return type
bool
- property stop_if_singular¶
Gets the stop_if_singular of this MUMPSSolver. # noqa: E501
Choose if the calculation should be stopped if the problem turns out to be singular. # noqa: E501
- Returns
The stop_if_singular of this MUMPSSolver. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this MUMPSSolver. # noqa: E501
<p>Choose a linear equation system solver for your calculation:</p><ul><li><p><b>Multfront</b> is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.</p></ul><ul><li><p><b>MUMPS</b> is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.</p></ul><ul><li><p><b>LDLT</b> is a direct solver which uses a Gaussian Algortihm. It is comparatively slow for big problems.</p></ul><ul><li><p><b>PETSC</b> is an iterative solver specially designed to deal with large systems. It scales very effectively in parallel and is the best choice for large problems.</p></ul><ul><li><p><b>GCPC</b> is an iterative solver of the pre-conditioned conjugate gradient type. It scales well in parallel and is also usable for large problems.</p></ul> Schema name: MUMPSSolver # noqa: E501
- Returns
The type of this MUMPSSolver. # noqa: E501
- Return type
str
simscale_sdk.models.natural_convection_inlet_outlet_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.natural_convection_inlet_outlet_bc.NaturalConvectionInletOutletBC(type='NATURAL_CONVECTION_INLET_OUTLET', name=None, pressure_rgh=None, temperature=None, net_radiative_heat_flux=None, radiative_intensity_ray=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'pressure_rgh': 'pressureRgh', 'radiative_intensity_ray': 'radiativeIntensityRay', 'temperature': 'temperature', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this NaturalConvectionInletOutletBC. # noqa: E501
- Returns
The name of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this NaturalConvectionInletOutletBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
OneOfNaturalConvectionInletOutletBCNetRadiativeHeatFlux
- openapi_types = {'name': 'str', 'net_radiative_heat_flux': 'OneOfNaturalConvectionInletOutletBCNetRadiativeHeatFlux', 'pressure_rgh': 'AmbientPBC', 'radiative_intensity_ray': 'OpenBoundaryRayBC', 'temperature': 'AmbientTBC', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property pressure_rgh¶
Gets the pressure_rgh of this NaturalConvectionInletOutletBC. # noqa: E501
- Returns
The pressure_rgh of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
- property radiative_intensity_ray¶
Gets the radiative_intensity_ray of this NaturalConvectionInletOutletBC. # noqa: E501
- Returns
The radiative_intensity_ray of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
- property temperature¶
Gets the temperature of this NaturalConvectionInletOutletBC. # noqa: E501
- Returns
The temperature of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this NaturalConvectionInletOutletBC. # noqa: E501
- Returns
The topological_reference of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
- property type¶
Gets the type of this NaturalConvectionInletOutletBC. # noqa: E501
<p>This boundary condition is suitable for an <b>open boundary</b> where the air can enter or exit freely from or to the <b>atmosphere<b>. <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/natural-convection-inlet-outlet/’ target=’_blank’>Learn more</a>.</P> Schema name: NaturalConvectionInletOutletBC # noqa: E501
- Returns
The type of this NaturalConvectionInletOutletBC. # noqa: E501
- Return type
str
simscale_sdk.models.neo_hooke_hyper_elastic_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.neo_hooke_hyper_elastic_model.NeoHookeHyperElasticModel(type='NEO_HOOKE', c10=None, d1=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'c10': 'c10', 'd1': 'd1', 'type': 'type'}¶
- property c10¶
Gets the c10 of this NeoHookeHyperElasticModel. # noqa: E501
- Returns
The c10 of this NeoHookeHyperElasticModel. # noqa: E501
- Return type
- property d1¶
Gets the d1 of this NeoHookeHyperElasticModel. # noqa: E501
- Returns
The d1 of this NeoHookeHyperElasticModel. # noqa: E501
- Return type
- openapi_types = {'c10': 'DimensionalPressure', 'd1': 'DimensionalInvPressure', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NeoHookeHyperElasticModel. # noqa: E501
<p>Choose the hyperelastic material model that should be used. All models derive the stress-strain relation from a strain energy function defined by the material model parameters.</p> Schema name: NeoHookeHyperElasticModel # noqa: E501
- Returns
The type of this NeoHookeHyperElasticModel. # noqa: E501
- Return type
str
simscale_sdk.models.new_region_refinement_pacefish_v38 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.new_region_refinement_pacefish_v38.NewRegionRefinementPacefishV38(type='REGION_PACEFISH_V38', name=None, mesh_sizing=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'mesh_sizing': 'meshSizing', 'name': 'name', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this NewRegionRefinementPacefishV38. # noqa: E501
- Returns
The geometry_primitive_uuids of this NewRegionRefinementPacefishV38. # noqa: E501
- Return type
list[str]
- property mesh_sizing¶
Gets the mesh_sizing of this NewRegionRefinementPacefishV38. # noqa: E501
- Returns
The mesh_sizing of this NewRegionRefinementPacefishV38. # noqa: E501
- Return type
OneOfNewRegionRefinementPacefishV38MeshSizing
- property name¶
Gets the name of this NewRegionRefinementPacefishV38. # noqa: E501
- Returns
The name of this NewRegionRefinementPacefishV38. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'mesh_sizing': 'OneOfNewRegionRefinementPacefishV38MeshSizing', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewRegionRefinementPacefishV38. # noqa: E501
Schema name: NewRegionRefinementPacefishV38 # noqa: E501
- Returns
The type of this NewRegionRefinementPacefishV38. # noqa: E501
- Return type
str
simscale_sdk.models.new_surface_refinement_pacefish_v38 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.new_surface_refinement_pacefish_v38.NewSurfaceRefinementPacefishV38(type='SURFACE_PACEFISH_V38', name=None, mesh_sizing=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mesh_sizing': 'meshSizing', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property mesh_sizing¶
Gets the mesh_sizing of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Returns
The mesh_sizing of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Return type
OneOfNewSurfaceRefinementPacefishV38MeshSizing
- property name¶
Gets the name of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Returns
The name of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Return type
str
- openapi_types = {'mesh_sizing': 'OneOfNewSurfaceRefinementPacefishV38MeshSizing', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Returns
The topological_reference of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Return type
- property type¶
Gets the type of this NewSurfaceRefinementPacefishV38. # noqa: E501
Schema name: NewSurfaceRefinementPacefishV38 # noqa: E501
- Returns
The type of this NewSurfaceRefinementPacefishV38. # noqa: E501
- Return type
str
simscale_sdk.models.newmark_time_integration_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newmark_time_integration_scheme.NewmarkTimeIntegrationScheme(type='NEWMARK', beta=None, gamma=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'beta': 'beta', 'gamma': 'gamma', 'type': 'type'}¶
- property beta¶
Gets the beta of this NewmarkTimeIntegrationScheme. # noqa: E501
<p>The choice of the values for the parameters <b>α</b> and <b>β</b> influences the stability, accuracy and numerical damping of the <i>Newmark Sheme</i>.</v> # noqa: E501
- Returns
The beta of this NewmarkTimeIntegrationScheme. # noqa: E501
- Return type
float
- property gamma¶
Gets the gamma of this NewmarkTimeIntegrationScheme. # noqa: E501
<p>The choice of the values for the parameters <b>α</b> and <b>β</b> influences the stability, accuracy and numerical damping of the <i>Newmark Sheme</i>.</v> # noqa: E501
- Returns
The gamma of this NewmarkTimeIntegrationScheme. # noqa: E501
- Return type
float
- openapi_types = {'beta': 'float', 'gamma': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewmarkTimeIntegrationScheme. # noqa: E501
Schema name: NewmarkTimeIntegrationScheme # noqa: E501
- Returns
The type of this NewmarkTimeIntegrationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.newton_contact_non_linearity_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newton_contact_non_linearity_resolution.NewtonContactNonLinearityResolution(type='NEWTON', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonContactNonLinearityResolution. # noqa: E501
Schema name: NewtonContactNonLinearityResolution # noqa: E501
- Returns
The type of this NewtonContactNonLinearityResolution. # noqa: E501
- Return type
str
simscale_sdk.models.newton_friction_non_linearity_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newton_friction_non_linearity_resolution.NewtonFrictionNonLinearityResolution(type='NEWTON_V29', iteration_criterion=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iteration_criterion': 'iterationCriterion', 'type': 'type'}¶
- property iteration_criterion¶
Gets the iteration_criterion of this NewtonFrictionNonLinearityResolution. # noqa: E501
- Returns
The iteration_criterion of this NewtonFrictionNonLinearityResolution. # noqa: E501
- Return type
float
- openapi_types = {'iteration_criterion': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonFrictionNonLinearityResolution. # noqa: E501
Schema name: NewtonFrictionNonLinearityResolution # noqa: E501
- Returns
The type of this NewtonFrictionNonLinearityResolution. # noqa: E501
- Return type
str
simscale_sdk.models.newton_iteration_timestep_calculation_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newton_iteration_timestep_calculation_type.NewtonIterationTimestepCalculationType(type='NEWTON_ITERATION', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonIterationTimestepCalculationType. # noqa: E501
<p>Select how the time increments should be computed in case of an adaptation event. Currently four types are available (which may not all be available for every event):</p><ul><li><p><b>Manual</b>: Here the user defines fixed time step subdivision and augmentation settings.</p></ul><ul><li><p><b>Newton Iterations Target</b>: With this setting the user defines a target value for the Newton Iterations and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Field Change Target</b>: With this setting the user defines a target value for change of a specific field component within a time increment and the time increments are calculated automatically to having this value as objective.</p></ul><ul><li><p><b>Mixed</b>: The mixed type uses a fixed subdivision and an automatic adaptation of the time step with a target value for the change of the selected field component.</p></ul> Schema name: NewtonIterationTimestepCalculationType # noqa: E501
- Returns
The type of this NewtonIterationTimestepCalculationType. # noqa: E501
- Return type
str
- property value¶
Gets the value of this NewtonIterationTimestepCalculationType. # noqa: E501
<p>Define the target value for the number of Newton Iterations within a time step.</p> # noqa: E501
- Returns
The value of this NewtonIterationTimestepCalculationType. # noqa: E501
- Return type
int
simscale_sdk.models.newton_krylov_resolution_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newton_krylov_resolution_type.NewtonKrylovResolutionType(type='NEWTON_KRYLOV', convergence_criteria=None, prediction_matrix=None, jacobian_matrix=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'convergence_criteria': 'convergenceCriteria', 'jacobian_matrix': 'jacobianMatrix', 'prediction_matrix': 'predictionMatrix', 'type': 'type'}¶
- property convergence_criteria¶
Gets the convergence_criteria of this NewtonKrylovResolutionType. # noqa: E501
- Returns
The convergence_criteria of this NewtonKrylovResolutionType. # noqa: E501
- Return type
OneOfNewtonKrylovResolutionTypeConvergenceCriteria
- property jacobian_matrix¶
Gets the jacobian_matrix of this NewtonKrylovResolutionType. # noqa: E501
- Returns
The jacobian_matrix of this NewtonKrylovResolutionType. # noqa: E501
- Return type
OneOfNewtonKrylovResolutionTypeJacobianMatrix
- openapi_types = {'convergence_criteria': 'OneOfNewtonKrylovResolutionTypeConvergenceCriteria', 'jacobian_matrix': 'OneOfNewtonKrylovResolutionTypeJacobianMatrix', 'prediction_matrix': 'str', 'type': 'str'}¶
- property prediction_matrix¶
Gets the prediction_matrix of this NewtonKrylovResolutionType. # noqa: E501
<p>Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.</p> # noqa: E501
- Returns
The prediction_matrix of this NewtonKrylovResolutionType. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonKrylovResolutionType. # noqa: E501
<p>Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection <b>Newton</b>. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection <b>Newton-Krylov</b>.</p> Schema name: NewtonKrylovResolutionType # noqa: E501
- Returns
The type of this NewtonKrylovResolutionType. # noqa: E501
- Return type
str
simscale_sdk.models.newton_non_linearity_resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newton_non_linearity_resolution.NewtonNonLinearityResolution(type='NEWTON', iteration_criterion=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'iteration_criterion': 'iterationCriterion', 'type': 'type'}¶
- property iteration_criterion¶
Gets the iteration_criterion of this NewtonNonLinearityResolution. # noqa: E501
- Returns
The iteration_criterion of this NewtonNonLinearityResolution. # noqa: E501
- Return type
float
- openapi_types = {'iteration_criterion': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonNonLinearityResolution. # noqa: E501
Schema name: NewtonNonLinearityResolution # noqa: E501
- Returns
The type of this NewtonNonLinearityResolution. # noqa: E501
- Return type
str
simscale_sdk.models.newton_resolution_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newton_resolution_type.NewtonResolutionType(type='NEWTON', convergence_criteria=None, prediction_matrix=None, jacobian_matrix=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'convergence_criteria': 'convergenceCriteria', 'jacobian_matrix': 'jacobianMatrix', 'prediction_matrix': 'predictionMatrix', 'type': 'type'}¶
- property convergence_criteria¶
Gets the convergence_criteria of this NewtonResolutionType. # noqa: E501
- Returns
The convergence_criteria of this NewtonResolutionType. # noqa: E501
- Return type
OneOfNewtonResolutionTypeConvergenceCriteria
- property jacobian_matrix¶
Gets the jacobian_matrix of this NewtonResolutionType. # noqa: E501
- Returns
The jacobian_matrix of this NewtonResolutionType. # noqa: E501
- Return type
OneOfNewtonResolutionTypeJacobianMatrix
- openapi_types = {'convergence_criteria': 'OneOfNewtonResolutionTypeConvergenceCriteria', 'jacobian_matrix': 'OneOfNewtonResolutionTypeJacobianMatrix', 'prediction_matrix': 'str', 'type': 'str'}¶
- property prediction_matrix¶
Gets the prediction_matrix of this NewtonResolutionType. # noqa: E501
<p>Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.</p> # noqa: E501
- Returns
The prediction_matrix of this NewtonResolutionType. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonResolutionType. # noqa: E501
<p>Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection <b>Newton</b>. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection <b>Newton-Krylov</b>.</p> Schema name: NewtonResolutionType # noqa: E501
- Returns
The type of this NewtonResolutionType. # noqa: E501
- Return type
str
simscale_sdk.models.newtonian_viscosity_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.newtonian_viscosity_model.NewtonianViscosityModel(type='NEWTONIAN', kinematic_viscosity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'kinematic_viscosity': 'kinematicViscosity', 'type': 'type'}¶
- property kinematic_viscosity¶
Gets the kinematic_viscosity of this NewtonianViscosityModel. # noqa: E501
- Returns
The kinematic_viscosity of this NewtonianViscosityModel. # noqa: E501
- Return type
- openapi_types = {'kinematic_viscosity': 'DimensionalKinematicViscosity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NewtonianViscosityModel. # noqa: E501
Choose between <a href=’https://www.simscale.com/docs/simulation-setup/materials/#newtonian-model’ target=’_blank’>Newtonian</a> and <a href=’https://www.simscale.com/docs/simulation-setup/materials/non-newtonian-models/’ target=’_blank’>Non-Newtonian</a> viscosity models. Schema name: NewtonianViscosityModel # noqa: E501
- Returns
The type of this NewtonianViscosityModel. # noqa: E501
- Return type
str
simscale_sdk.models.no_creep_formulation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.no_creep_formulation.NoCreepFormulation(type='NO_CREEP', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoCreepFormulation. # noqa: E501
<p>Define the Creep formulation. Two fundamental Creep law types are available: <ul><li><b>Power Law</b></li><b>ε̇ = m*A*σ<sup>n</sup>*t<sup>m-1</sup></b><li><b>Hyperbolic Sine Law</b> </li><b>ε̇= ε<sub>0</sub>* sinh(σ/(σ<sub>0</sub>))<sup>n</sup></b>.</ul> For the Power Law different formulations, like the <b>Norton</b>, <b>Strain Hardening</b> or <b>Time Hardening</b> are available. For the Hyperbolic Sine Law, the <b>Garofalo<b> formulation is available.</p> Schema name: NoCreepFormulation # noqa: E501
- Returns
The type of this NoCreepFormulation. # noqa: E501
- Return type
str
simscale_sdk.models.no_fictitious_clearance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.no_fictitious_clearance.NoFictitiousClearance(type='NO_FICTITIOUS_CLEARANCE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoFictitiousClearance. # noqa: E501
Schema name: NoFictitiousClearance # noqa: E501
- Returns
The type of this NoFictitiousClearance. # noqa: E501
- Return type
str
simscale_sdk.models.no_friction module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.no_friction.NoFriction(type='NO_FRICTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoFriction. # noqa: E501
Schema name: NoFriction # noqa: E501
- Returns
The type of this NoFriction. # noqa: E501
- Return type
str
simscale_sdk.models.no_primary_topology module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.no_primary_topology.NoPrimaryTopology(type='NO_PRIMARY_TOPOLOGY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoPrimaryTopology. # noqa: E501
Schema name: NoPrimaryTopology # noqa: E501
- Returns
The type of this NoPrimaryTopology. # noqa: E501
- Return type
str
simscale_sdk.models.no_slip_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.no_slip_vbc.NoSlipVBC(type='NO_SLIP', turbulence_wall=None, surface_roughness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'surface_roughness': 'surfaceRoughness', 'turbulence_wall': 'turbulenceWall', 'type': 'type'}¶
- openapi_types = {'surface_roughness': 'DimensionalLength', 'turbulence_wall': 'str', 'type': 'str'}¶
- property surface_roughness¶
Gets the surface_roughness of this NoSlipVBC. # noqa: E501
- Returns
The surface_roughness of this NoSlipVBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_wall¶
Gets the turbulence_wall of this NoSlipVBC. # noqa: E501
- Returns
The turbulence_wall of this NoSlipVBC. # noqa: E501
- Return type
str
- property type¶
Gets the type of this NoSlipVBC. # noqa: E501
Schema name: NoSlipVBC # noqa: E501
- Returns
The type of this NoSlipVBC. # noqa: E501
- Return type
str
simscale_sdk.models.no_wall_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.no_wall_thermal.NoWallThermal(type='NO_RESISTANCE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoWallThermal. # noqa: E501
Schema name: NoWallThermal # noqa: E501
- Returns
The type of this NoWallThermal. # noqa: E501
- Return type
str
simscale_sdk.models.nodal_force_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.nodal_force_type.NodalForceType(type='NODAL', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this NodalForceType. # noqa: E501
- Returns
The component_selection of this NodalForceType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NodalForceType. # noqa: E501
Schema name: NodalForceType # noqa: E501
- Returns
The type of this NodalForceType. # noqa: E501
- Return type
str
simscale_sdk.models.nodal_load_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.nodal_load_bc.NodalLoadBC(type='NODAL_LOAD', name=None, force=None, scaling=None, phase_angle=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'force': 'force', 'name': 'name', 'phase_angle': 'phaseAngle', 'scaling': 'scaling', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property force¶
Gets the force of this NodalLoadBC. # noqa: E501
- Returns
The force of this NodalLoadBC. # noqa: E501
- Return type
- property name¶
Gets the name of this NodalLoadBC. # noqa: E501
- Returns
The name of this NodalLoadBC. # noqa: E501
- Return type
str
- openapi_types = {'force': 'DimensionalVectorFunctionForce', 'name': 'str', 'phase_angle': 'DimensionalAngle', 'scaling': 'DimensionalFunctionDimensionless', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this NodalLoadBC. # noqa: E501
- Returns
The phase_angle of this NodalLoadBC. # noqa: E501
- Return type
- property scaling¶
Gets the scaling of this NodalLoadBC. # noqa: E501
- Returns
The scaling of this NodalLoadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this NodalLoadBC. # noqa: E501
- Returns
The topological_reference of this NodalLoadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this NodalLoadBC. # noqa: E501
This is a <b>force</b> boundary condition representing an equal point force on <b>each node of the assignment</b>. The total force applied on the assignment is calculated as the user defined forces times the number of nodes in the assignment.<br /><br />Important remarks: <br /><ul><li>Currently, it only works on <a href= https://www.simscale.com/docs/simulation-setup/meshing/mesh-upload/’ target=’_blank’>uploaded meshes</a></li><li>As the total load is depending on the number of nodes, and thus the mesh fineness, it is recommended only for loads on single nodes.</li><li>In most cases point loads are unphysical and distributed loads should be used instead.</li></ul> Schema name: NodalLoadBC # noqa: E501
- Returns
The type of this NodalLoadBC. # noqa: E501
- Return type
str
simscale_sdk.models.nodal_moment_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.nodal_moment_type.NodalMomentType(type='NODAL', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this NodalMomentType. # noqa: E501
- Returns
The component_selection of this NodalMomentType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NodalMomentType. # noqa: E501
Schema name: NodalMomentType # noqa: E501
- Returns
The type of this NodalMomentType. # noqa: E501
- Return type
str
simscale_sdk.models.non_monotomous_residual_retiming_event module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.non_monotomous_residual_retiming_event.NonMonotomousResidualRetimingEvent(type='NON_MONOTOMOUS_RESIDUAL', timestep_calculation_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'timestep_calculation_type': 'timestepCalculationType', 'type': 'type'}¶
- openapi_types = {'timestep_calculation_type': 'OneOfNonMonotomousResidualRetimingEventTimestepCalculationType', 'type': 'str'}¶
- property timestep_calculation_type¶
Gets the timestep_calculation_type of this NonMonotomousResidualRetimingEvent. # noqa: E501
- Returns
The timestep_calculation_type of this NonMonotomousResidualRetimingEvent. # noqa: E501
- Return type
OneOfNonMonotomousResidualRetimingEventTimestepCalculationType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NonMonotomousResidualRetimingEvent. # noqa: E501
<p>Select the event for the time step adaptation. Currently there are four different events possible that trigger a time step adaptation:</p><ul><li><p><b>Error</b>: This is the case of a general error like for example non-convergence or singular matrix errors.</p></ul><ul><li><p><b>Collision</b>: This event is triggered if in a computation with physical contact a contact state change from open to closed is noticed. This time step adaptation is especially useful in dynamics to reduce the effect of artificial oscillations due to inexact collision detection.</p></ul><ul><li><p><b>Field Change</b>: The user can define the maximum delta that a field is allowed to change within one time step, if the defined threshold is exceeded the time step is adapted. This time stepping criteria is especially useful to capture material nonlinearitier more exact.</p></ul><ul><li><p><b>Non-monotonous residual</b>: This event is triggered if the residual has not been reduced within three iterations . This criteria is mostly used to reduce runtime by detecting diverging time steps before reaching the maximum number of allowed newton iterations.</p></ul> Schema name: NonMonotomousResidualRetimingEvent # noqa: E501
- Returns
The type of this NonMonotomousResidualRetimingEvent. # noqa: E501
- Return type
str
simscale_sdk.models.none_damping module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.none_damping.NoneDamping(type='NONE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoneDamping. # noqa: E501
<p>Choose if damping effects should be considered. The supported damping types are:<ul><li><p><b>Rayleigh Damping</b> which is also known as <i>proportional viscous damping</i>. This model assumes that the damping is proportional to the vibrating velocity.</p></ul><ul><li><p><b>Hysteretic Damping</b>, also known as <i>structural damping</i>. Here the damping is assumed to be proportional to the displacement.</p></ul><br><a href= https://www.simscale.com/docs/simulation-setup/materials/damping/’ target=’_blank’>Learn more</a>. Schema name: NoneDamping # noqa: E501
- Returns
The type of this NoneDamping. # noqa: E501
- Return type
str
simscale_sdk.models.none_reactualization module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.none_reactualization.NoneReactualization(type='NONE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NoneReactualization. # noqa: E501
Schema name: NoneReactualization # noqa: E501
- Returns
The type of this NoneReactualization. # noqa: E501
- Return type
str
simscale_sdk.models.norton_creep_formulation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.norton_creep_formulation.NortonCreepFormulation(type='NORTON', a=None, n=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property a¶
Gets the a of this NortonCreepFormulation. # noqa: E501
- Returns
The a of this NortonCreepFormulation. # noqa: E501
- Return type
- attribute_map = {'a': 'a', 'n': 'n', 'type': 'type'}¶
- property n¶
Gets the n of this NortonCreepFormulation. # noqa: E501
<p>Define the parameter <b>n</b> of the Norton creep formulation: <ul><b>ε̇ = A*σ<sup>n</sup></b></ul></p> # noqa: E501
- Returns
The n of this NortonCreepFormulation. # noqa: E501
- Return type
float
- openapi_types = {'a': 'DimensionalStrainRate', 'n': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NortonCreepFormulation. # noqa: E501
<p>Define the Creep formulation. Two fundamental Creep law types are available: <ul><li><b>Power Law</b></li><b>ε̇ = m*A*σ<sup>n</sup>*t<sup>m-1</sup></b><li><b>Hyperbolic Sine Law</b> </li><b>ε̇= ε<sub>0</sub>* sinh(σ/(σ<sub>0</sub>))<sup>n</sup></b>.</ul> For the Power Law different formulations, like the <b>Norton</b>, <b>Strain Hardening</b> or <b>Time Hardening</b> are available. For the Hyperbolic Sine Law, the <b>Garofalo<b> formulation is available.</p> Schema name: NortonCreepFormulation # noqa: E501
- Returns
The type of this NortonCreepFormulation. # noqa: E501
- Return type
str
simscale_sdk.models.number_iterations_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.number_iterations_write_control.NumberIterationsWriteControl(type='NUMBER_OF_ITERATIONS_STEADY_STATE', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NumberIterationsWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: NumberIterationsWriteControl # noqa: E501
- Returns
The type of this NumberIterationsWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this NumberIterationsWriteControl. # noqa: E501
Specify an interval value that defines the number of iterations between two writes of the result. # noqa: E501
- Returns
The write_interval of this NumberIterationsWriteControl. # noqa: E501
- Return type
int
simscale_sdk.models.number_of_cells_per_direction module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.number_of_cells_per_direction.NumberOfCellsPerDirection(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'x': 'int', 'y': 'int', 'z': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this NumberOfCellsPerDirection. # noqa: E501
- Returns
The x of this NumberOfCellsPerDirection. # noqa: E501
- Return type
int
- property y¶
Gets the y of this NumberOfCellsPerDirection. # noqa: E501
- Returns
The y of this NumberOfCellsPerDirection. # noqa: E501
- Return type
int
- property z¶
Gets the z of this NumberOfCellsPerDirection. # noqa: E501
- Returns
The z of this NumberOfCellsPerDirection. # noqa: E501
- Return type
int
simscale_sdk.models.numerical_sequence_parameter_value_generator module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.numerical_sequence_parameter_value_generator.NumericalSequenceParameterValueGenerator(type='NUMERICAL_SEQUENCE', start=None, end=None, step=None, inclusive=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'end': 'end', 'inclusive': 'inclusive', 'start': 'start', 'step': 'step', 'type': 'type'}¶
- property end¶
Gets the end of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Returns
The end of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Return type
float
- property inclusive¶
Gets the inclusive of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Returns
The inclusive of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Return type
bool
- openapi_types = {'end': 'float', 'inclusive': 'bool', 'start': 'float', 'step': 'float', 'type': 'str'}¶
- property start¶
Gets the start of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Returns
The start of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Return type
float
- property step¶
Gets the step of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Returns
The step of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this NumericalSequenceParameterValueGenerator. # noqa: E501
Schema name: NumericalSequenceParameterValueGenerator # noqa: E501
- Returns
The type of this NumericalSequenceParameterValueGenerator. # noqa: E501
- Return type
str
simscale_sdk.models.oak module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.oak.Oak(type='OAK', average_tree_height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_tree_height': 'averageTreeHeight', 'type': 'type'}¶
- property average_tree_height¶
Gets the average_tree_height of this Oak. # noqa: E501
- Returns
The average_tree_height of this Oak. # noqa: E501
- Return type
- openapi_types = {'average_tree_height': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Oak. # noqa: E501
Schema name: Oak # noqa: E501
- Returns
The type of this Oak. # noqa: E501
- Return type
str
simscale_sdk.models.off_position_tolerance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.off_position_tolerance.OffPositionTolerance(type='OFF', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OffPositionTolerance. # noqa: E501
Schema name: OffPositionTolerance # noqa: E501
- Returns
The type of this OffPositionTolerance. # noqa: E501
- Return type
str
simscale_sdk.models.open_boundary_ray_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.open_boundary_ray_bc.OpenBoundaryRayBC(type='OPEN_BOUNDARY_RAY', farfield_black_body_temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'farfield_black_body_temperature': 'farfieldBlackBodyTemperature', 'type': 'type'}¶
- property farfield_black_body_temperature¶
Gets the farfield_black_body_temperature of this OpenBoundaryRayBC. # noqa: E501
- Returns
The farfield_black_body_temperature of this OpenBoundaryRayBC. # noqa: E501
- Return type
- openapi_types = {'farfield_black_body_temperature': 'DimensionalTemperature', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OpenBoundaryRayBC. # noqa: E501
Schema name: OpenBoundaryRayBC # noqa: E501
- Returns
The type of this OpenBoundaryRayBC. # noqa: E501
- Return type
str
simscale_sdk.models.open_window_rsbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.open_window_rsbc.OpenWindowRSBC(type='OPEN_WINDOW', radiative_source_value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'radiative_source_value': 'radiativeSourceValue', 'type': 'type'}¶
- openapi_types = {'radiative_source_value': 'DimensionalHeatFlux', 'type': 'str'}¶
- property radiative_source_value¶
Gets the radiative_source_value of this OpenWindowRSBC. # noqa: E501
- Returns
The radiative_source_value of this OpenWindowRSBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OpenWindowRSBC. # noqa: E501
Schema name: OpenWindowRSBC # noqa: E501
- Returns
The type of this OpenWindowRSBC. # noqa: E501
- Return type
str
simscale_sdk.models.original_entity_reference module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.original_entity_reference.OriginalEntityReference(path=None, body=None, entity=None, attribute_list=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property attribute_list¶
Gets the attribute_list of this OriginalEntityReference. # noqa: E501
The attributes assigned to the entity. # noqa: E501
- Returns
The attribute_list of this OriginalEntityReference. # noqa: E501
- Return type
list[EntityAttribute]
- attribute_map = {'attribute_list': 'attributeList', 'body': 'body', 'entity': 'entity', 'path': 'path'}¶
- property body¶
Gets the body of this OriginalEntityReference. # noqa: E501
The original body name. # noqa: E501
- Returns
The body of this OriginalEntityReference. # noqa: E501
- Return type
str
- property entity¶
Gets the entity of this OriginalEntityReference. # noqa: E501
The original entity name. # noqa: E501
- Returns
The entity of this OriginalEntityReference. # noqa: E501
- Return type
str
- openapi_types = {'attribute_list': 'list[EntityAttribute]', 'body': 'str', 'entity': 'str', 'path': 'list[BodyPath]'}¶
- property path¶
Gets the path of this OriginalEntityReference. # noqa: E501
The path from the root of the model. # noqa: E501
- Returns
The path of this OriginalEntityReference. # noqa: E501
- Return type
list[BodyPath]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.orthotropic_conductivity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.orthotropic_conductivity.OrthotropicConductivity(type='ORTHOTROPIC', thermal_conductivity_x=None, thermal_conductivity_y=None, thermal_conductivity_z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'thermal_conductivity_x': 'thermalConductivityX', 'thermal_conductivity_y': 'thermalConductivityY', 'thermal_conductivity_z': 'thermalConductivityZ', 'type': 'type'}¶
- openapi_types = {'thermal_conductivity_x': 'DimensionalFunctionThermalConductivity', 'thermal_conductivity_y': 'DimensionalFunctionThermalConductivity', 'thermal_conductivity_z': 'DimensionalFunctionThermalConductivity', 'type': 'str'}¶
- property thermal_conductivity_x¶
Gets the thermal_conductivity_x of this OrthotropicConductivity. # noqa: E501
- Returns
The thermal_conductivity_x of this OrthotropicConductivity. # noqa: E501
- Return type
- property thermal_conductivity_y¶
Gets the thermal_conductivity_y of this OrthotropicConductivity. # noqa: E501
- Returns
The thermal_conductivity_y of this OrthotropicConductivity. # noqa: E501
- Return type
- property thermal_conductivity_z¶
Gets the thermal_conductivity_z of this OrthotropicConductivity. # noqa: E501
- Returns
The thermal_conductivity_z of this OrthotropicConductivity. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OrthotropicConductivity. # noqa: E501
<p>Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.</p> Schema name: OrthotropicConductivity # noqa: E501
- Returns
The type of this OrthotropicConductivity. # noqa: E501
- Return type
str
simscale_sdk.models.orthotropic_spring_stiffness module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.orthotropic_spring_stiffness.OrthotropicSpringStiffness(type='ORTHOTROPIC', stiffness_definition=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'stiffness_definition': 'stiffnessDefinition', 'type': 'type'}¶
- openapi_types = {'stiffness_definition': 'OneOfOrthotropicSpringStiffnessStiffnessDefinition', 'type': 'str'}¶
- property stiffness_definition¶
Gets the stiffness_definition of this OrthotropicSpringStiffness. # noqa: E501
- Returns
The stiffness_definition of this OrthotropicSpringStiffness. # noqa: E501
- Return type
OneOfOrthotropicSpringStiffnessStiffnessDefinition
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OrthotropicSpringStiffness. # noqa: E501
Schema name: OrthotropicSpringStiffness # noqa: E501
- Returns
The type of this OrthotropicSpringStiffness. # noqa: E501
- Return type
str
simscale_sdk.models.oscillating_linear_sbm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.oscillating_linear_sbm.OscillatingLinearSBM(type='OSCILLATING_LINEAR_MOTION', name=None, amplitude=None, angular_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property amplitude¶
Gets the amplitude of this OscillatingLinearSBM. # noqa: E501
- Returns
The amplitude of this OscillatingLinearSBM. # noqa: E501
- Return type
- property angular_velocity¶
Gets the angular_velocity of this OscillatingLinearSBM. # noqa: E501
- Returns
The angular_velocity of this OscillatingLinearSBM. # noqa: E501
- Return type
- attribute_map = {'amplitude': 'amplitude', 'angular_velocity': 'angularVelocity', 'name': 'name', 'type': 'type'}¶
- property name¶
Gets the name of this OscillatingLinearSBM. # noqa: E501
- Returns
The name of this OscillatingLinearSBM. # noqa: E501
- Return type
str
- openapi_types = {'amplitude': 'DimensionalVectorLength', 'angular_velocity': 'DimensionalRotationSpeed', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OscillatingLinearSBM. # noqa: E501
Schema name: OscillatingLinearSBM # noqa: E501
- Returns
The type of this OscillatingLinearSBM. # noqa: E501
- Return type
str
simscale_sdk.models.oscillating_rotating_motion_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.oscillating_rotating_motion_type.OscillatingRotatingMotionType(type='OSCILLATING_ROTATING_MOTION', rotation_center=None, amplitude=None, angular_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property amplitude¶
Gets the amplitude of this OscillatingRotatingMotionType. # noqa: E501
- Returns
The amplitude of this OscillatingRotatingMotionType. # noqa: E501
- Return type
- property angular_velocity¶
Gets the angular_velocity of this OscillatingRotatingMotionType. # noqa: E501
- Returns
The angular_velocity of this OscillatingRotatingMotionType. # noqa: E501
- Return type
- attribute_map = {'amplitude': 'amplitude', 'angular_velocity': 'angularVelocity', 'rotation_center': 'rotationCenter', 'type': 'type'}¶
- openapi_types = {'amplitude': 'DimensionalVectorAngle', 'angular_velocity': 'DimensionalFunctionRotationSpeed', 'rotation_center': 'DimensionalVectorLength', 'type': 'str'}¶
- property rotation_center¶
Gets the rotation_center of this OscillatingRotatingMotionType. # noqa: E501
- Returns
The rotation_center of this OscillatingRotatingMotionType. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OscillatingRotatingMotionType. # noqa: E501
Schema name: OscillatingRotatingMotionType # noqa: E501
- Returns
The type of this OscillatingRotatingMotionType. # noqa: E501
- Return type
str
simscale_sdk.models.oscillating_rotating_sbm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.oscillating_rotating_sbm.OscillatingRotatingSBM(type='OSCILLATING_ROTATING_MOTION', name=None, rotation_center=None, amplitude=None, angular_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property amplitude¶
Gets the amplitude of this OscillatingRotatingSBM. # noqa: E501
- Returns
The amplitude of this OscillatingRotatingSBM. # noqa: E501
- Return type
- property angular_velocity¶
Gets the angular_velocity of this OscillatingRotatingSBM. # noqa: E501
- Returns
The angular_velocity of this OscillatingRotatingSBM. # noqa: E501
- Return type
- attribute_map = {'amplitude': 'amplitude', 'angular_velocity': 'angularVelocity', 'name': 'name', 'rotation_center': 'rotationCenter', 'type': 'type'}¶
- property name¶
Gets the name of this OscillatingRotatingSBM. # noqa: E501
- Returns
The name of this OscillatingRotatingSBM. # noqa: E501
- Return type
str
- openapi_types = {'amplitude': 'DimensionalVectorAngle', 'angular_velocity': 'DimensionalRotationSpeed', 'name': 'str', 'rotation_center': 'DimensionalVectorLength', 'type': 'str'}¶
- property rotation_center¶
Gets the rotation_center of this OscillatingRotatingSBM. # noqa: E501
- Returns
The rotation_center of this OscillatingRotatingSBM. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OscillatingRotatingSBM. # noqa: E501
Schema name: OscillatingRotatingSBM # noqa: E501
- Returns
The type of this OscillatingRotatingSBM. # noqa: E501
- Return type
str
simscale_sdk.models.outlet_mean_phase_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.outlet_mean_phase_vbc.OutletMeanPhaseVBC(type='OUTLET_MEAN_PHASE', phase=None, mean_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mean_velocity': 'meanVelocity', 'phase': 'phase', 'type': 'type'}¶
- property mean_velocity¶
Gets the mean_velocity of this OutletMeanPhaseVBC. # noqa: E501
- Returns
The mean_velocity of this OutletMeanPhaseVBC. # noqa: E501
- Return type
- openapi_types = {'mean_velocity': 'DimensionalSpeed', 'phase': 'str', 'type': 'str'}¶
- property phase¶
Gets the phase of this OutletMeanPhaseVBC. # noqa: E501
- Returns
The phase of this OutletMeanPhaseVBC. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OutletMeanPhaseVBC. # noqa: E501
Schema name: OutletMeanPhaseVBC # noqa: E501
- Returns
The type of this OutletMeanPhaseVBC. # noqa: E501
- Return type
str
simscale_sdk.models.outside_region_refinement_with_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.outside_region_refinement_with_length.OutsideRegionRefinementWithLength(type='OUTSIDE', length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'length': 'length', 'type': 'type'}¶
- property length¶
Gets the length of this OutsideRegionRefinementWithLength. # noqa: E501
- Returns
The length of this OutsideRegionRefinementWithLength. # noqa: E501
- Return type
- openapi_types = {'length': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OutsideRegionRefinementWithLength. # noqa: E501
Schema name: OutsideRegionRefinementWithLength # noqa: E501
- Returns
The type of this OutsideRegionRefinementWithLength. # noqa: E501
- Return type
str
simscale_sdk.models.outside_region_refinement_with_levels module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.outside_region_refinement_with_levels.OutsideRegionRefinementWithLevels(type='OUTSIDE', level=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'level': 'level', 'type': 'type'}¶
- property level¶
Gets the level of this OutsideRegionRefinementWithLevels. # noqa: E501
- Returns
The level of this OutsideRegionRefinementWithLevels. # noqa: E501
- Return type
int
- openapi_types = {'level': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this OutsideRegionRefinementWithLevels. # noqa: E501
Schema name: OutsideRegionRefinementWithLevels # noqa: E501
- Returns
The type of this OutsideRegionRefinementWithLevels. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_automesh module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_automesh.PacefishAutomesh(type='PACEFISH_AUTOMESH', new_fineness=None, reference_length_computation=None, primary_topology=None, refinements=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'new_fineness': 'newFineness', 'primary_topology': 'primaryTopology', 'reference_length_computation': 'referenceLengthComputation', 'refinements': 'refinements', 'type': 'type'}¶
- property new_fineness¶
Gets the new_fineness of this PacefishAutomesh. # noqa: E501
- Returns
The new_fineness of this PacefishAutomesh. # noqa: E501
- Return type
OneOfPacefishAutomeshNewFineness
- openapi_types = {'new_fineness': 'OneOfPacefishAutomeshNewFineness', 'primary_topology': 'OneOfPacefishAutomeshPrimaryTopology', 'reference_length_computation': 'OneOfPacefishAutomeshReferenceLengthComputation', 'refinements': 'list[OneOfPacefishAutomeshRefinements]', 'type': 'str'}¶
- property primary_topology¶
Gets the primary_topology of this PacefishAutomesh. # noqa: E501
- Returns
The primary_topology of this PacefishAutomesh. # noqa: E501
- Return type
OneOfPacefishAutomeshPrimaryTopology
- property reference_length_computation¶
Gets the reference_length_computation of this PacefishAutomesh. # noqa: E501
- Returns
The reference_length_computation of this PacefishAutomesh. # noqa: E501
- Return type
OneOfPacefishAutomeshReferenceLengthComputation
- property refinements¶
Gets the refinements of this PacefishAutomesh. # noqa: E501
- Returns
The refinements of this PacefishAutomesh. # noqa: E501
- Return type
list[OneOfPacefishAutomeshRefinements]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishAutomesh. # noqa: E501
<p>Choose between <i>Automatic</i> and <i>Manual</i> mesh settings. <a href=’https://www.simscale.com/docs/analysis-types/incompressible-lbm/#mesh’ target=’_blank’>Learn more.</a></p><p><b>Note:</b> Mesh fineness impacts the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishAutomesh # noqa: E501
- Returns
The type of this PacefishAutomesh. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_fineness_coarse module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_fineness_coarse.PacefishFinenessCoarse(type='COARSE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishFinenessCoarse. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishFinenessCoarse # noqa: E501
- Returns
The type of this PacefishFinenessCoarse. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_fineness_fine module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_fineness_fine.PacefishFinenessFine(type='FINE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishFinenessFine. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishFinenessFine # noqa: E501
- Returns
The type of this PacefishFinenessFine. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_fineness_moderate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_fineness_moderate.PacefishFinenessModerate(type='MODERATE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishFinenessModerate. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishFinenessModerate # noqa: E501
- Returns
The type of this PacefishFinenessModerate. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_fineness_target_size module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_fineness_target_size.PacefishFinenessTargetSize(type='TARGET_SIZE', minimum_cell_size=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'minimum_cell_size': 'minimumCellSize', 'type': 'type'}¶
- property minimum_cell_size¶
Gets the minimum_cell_size of this PacefishFinenessTargetSize. # noqa: E501
- Returns
The minimum_cell_size of this PacefishFinenessTargetSize. # noqa: E501
- Return type
- openapi_types = {'minimum_cell_size': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishFinenessTargetSize. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishFinenessTargetSize # noqa: E501
- Returns
The type of this PacefishFinenessTargetSize. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_fineness_very_coarse module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_fineness_very_coarse.PacefishFinenessVeryCoarse(type='VERY_COARSE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishFinenessVeryCoarse. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishFinenessVeryCoarse # noqa: E501
- Returns
The type of this PacefishFinenessVeryCoarse. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_fineness_very_fine module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_fineness_very_fine.PacefishFinenessVeryFine(type='VERY_FINE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishFinenessVeryFine. # noqa: E501
<p>This parameter determines the <b>fineness of the mesh</b> and affects the overall number of cells. It is recommended to start with the <i>coarse</i> setting. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/mesh-settings/’ target=’_blank’>Find out more.</a></p><p><b>Note:</b> This setting will impact the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishFinenessVeryFine # noqa: E501
- Returns
The type of this PacefishFinenessVeryFine. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_mesh_legacy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_mesh_legacy.PacefishMeshLegacy(type='PACEFISH_MESH_LEGACY', fineness=None, reference_length=None, reynolds_scaling=None, refinements=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'reference_length': 'referenceLength', 'refinements': 'refinements', 'reynolds_scaling': 'reynoldsScaling', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this PacefishMeshLegacy. # noqa: E501
- Returns
The fineness of this PacefishMeshLegacy. # noqa: E501
- Return type
str
- openapi_types = {'fineness': 'str', 'reference_length': 'DimensionalLength', 'refinements': 'list[OneOfPacefishMeshLegacyRefinements]', 'reynolds_scaling': 'float', 'type': 'str'}¶
- property reference_length¶
Gets the reference_length of this PacefishMeshLegacy. # noqa: E501
- Returns
The reference_length of this PacefishMeshLegacy. # noqa: E501
- Return type
- property refinements¶
Gets the refinements of this PacefishMeshLegacy. # noqa: E501
- Returns
The refinements of this PacefishMeshLegacy. # noqa: E501
- Return type
list[OneOfPacefishMeshLegacyRefinements]
- property reynolds_scaling¶
Gets the reynolds_scaling of this PacefishMeshLegacy. # noqa: E501
Use this factor to scale the Reynolds number of your simulation. For example, to change the Reynolds number from 10<sup>8</sup> to 10<sup>6</sup>, set this factor to 0.01. <a href= https://www.simscale.com/docs/incompressible-lbm-lattice-boltzmann-advanced/#reynolds-scaling-factor’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The reynolds_scaling of this PacefishMeshLegacy. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishMeshLegacy. # noqa: E501
<p>Choose between <i>Automatic</i> and <i>Manual</i> mesh settings. <a href=’https://www.simscale.com/docs/analysis-types/incompressible-lbm/#mesh’ target=’_blank’>Learn more.</a></p><p><b>Note:</b> Mesh fineness impacts the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishMeshLegacy # noqa: E501
- Returns
The type of this PacefishMeshLegacy. # noqa: E501
- Return type
str
simscale_sdk.models.pacefish_mesh_v38 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pacefish_mesh_v38.PacefishMeshV38(type='PACEFISH_MESH_V38', fineness=None, reference_length=None, primary_topology=None, refinements=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fineness': 'fineness', 'primary_topology': 'primaryTopology', 'reference_length': 'referenceLength', 'refinements': 'refinements', 'type': 'type'}¶
- property fineness¶
Gets the fineness of this PacefishMeshV38. # noqa: E501
- Returns
The fineness of this PacefishMeshV38. # noqa: E501
- Return type
str
- openapi_types = {'fineness': 'str', 'primary_topology': 'OneOfPacefishMeshV38PrimaryTopology', 'reference_length': 'DimensionalLength', 'refinements': 'list[OneOfPacefishMeshV38Refinements]', 'type': 'str'}¶
- property primary_topology¶
Gets the primary_topology of this PacefishMeshV38. # noqa: E501
- Returns
The primary_topology of this PacefishMeshV38. # noqa: E501
- Return type
OneOfPacefishMeshV38PrimaryTopology
- property reference_length¶
Gets the reference_length of this PacefishMeshV38. # noqa: E501
- Returns
The reference_length of this PacefishMeshV38. # noqa: E501
- Return type
- property refinements¶
Gets the refinements of this PacefishMeshV38. # noqa: E501
- Returns
The refinements of this PacefishMeshV38. # noqa: E501
- Return type
list[OneOfPacefishMeshV38Refinements]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PacefishMeshV38. # noqa: E501
<p>Choose between <i>Automatic</i> and <i>Manual</i> mesh settings. <a href=’https://www.simscale.com/docs/analysis-types/incompressible-lbm/#mesh’ target=’_blank’>Learn more.</a></p><p><b>Note:</b> Mesh fineness impacts the accuracy of your results as well as computing time and result size. A finer mesh will be more demanding in terms of machine size and memory but lead to more accurate results in most cases.</p> Schema name: PacefishMeshV38 # noqa: E501
- Returns
The type of this PacefishMeshV38. # noqa: E501
- Return type
str
simscale_sdk.models.parameter_with_value_generator module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.parameter_with_value_generator.ParameterWithValueGenerator(value_source='GENERATOR', name=None, path=None, value_generator=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'path': 'path', 'value_generator': 'valueGenerator', 'value_source': 'valueSource'}¶
- property name¶
Gets the name of this ParameterWithValueGenerator. # noqa: E501
- Returns
The name of this ParameterWithValueGenerator. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'path': 'str', 'value_generator': 'NumericalSequenceParameterValueGenerator', 'value_source': 'str'}¶
- property path¶
Gets the path of this ParameterWithValueGenerator. # noqa: E501
- Returns
The path of this ParameterWithValueGenerator. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property value_generator¶
Gets the value_generator of this ParameterWithValueGenerator. # noqa: E501
- Returns
The value_generator of this ParameterWithValueGenerator. # noqa: E501
- Return type
- property value_source¶
Gets the value_source of this ParameterWithValueGenerator. # noqa: E501
Schema name: ParameterWithValueGenerator # noqa: E501
- Returns
The value_source of this ParameterWithValueGenerator. # noqa: E501
- Return type
str
simscale_sdk.models.parameter_with_values module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.parameter_with_values.ParameterWithValues(value_source='CONFIGURATION', name=None, path=None, values=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'path': 'path', 'value_source': 'valueSource', 'values': 'values'}¶
- property name¶
Gets the name of this ParameterWithValues. # noqa: E501
- Returns
The name of this ParameterWithValues. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'path': 'str', 'value_source': 'str', 'values': 'list[AnyOfParameterWithValuesValues]'}¶
- property path¶
Gets the path of this ParameterWithValues. # noqa: E501
- Returns
The path of this ParameterWithValues. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property value_source¶
Gets the value_source of this ParameterWithValues. # noqa: E501
Schema name: ParameterWithValues # noqa: E501
- Returns
The value_source of this ParameterWithValues. # noqa: E501
- Return type
str
- property values¶
Gets the values of this ParameterWithValues. # noqa: E501
- Returns
The values of this ParameterWithValues. # noqa: E501
- Return type
simscale_sdk.models.parametric_material_property module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.parametric_material_property.ParametricMaterialProperty(name=None, unit=None, value_type='parametric', data_type=None, parameters=None, parametric_values=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'data_type': 'dataType', 'name': 'name', 'parameters': 'parameters', 'parametric_values': 'parametricValues', 'unit': 'unit', 'value_type': 'valueType'}¶
- property data_type¶
Gets the data_type of this ParametricMaterialProperty. # noqa: E501
- Returns
The data_type of this ParametricMaterialProperty. # noqa: E501
- Return type
- property name¶
Gets the name of this ParametricMaterialProperty. # noqa: E501
The material property name # noqa: E501
- Returns
The name of this ParametricMaterialProperty. # noqa: E501
- Return type
str
- openapi_types = {'data_type': 'PropertyDataType', 'name': 'str', 'parameters': 'list[MaterialPropertyParameter]', 'parametric_values': 'list[dict(str, object)]', 'unit': 'str', 'value_type': 'str'}¶
- property parameters¶
Gets the parameters of this ParametricMaterialProperty. # noqa: E501
Parameter properties of the material # noqa: E501
- Returns
The parameters of this ParametricMaterialProperty. # noqa: E501
- Return type
- property parametric_values¶
Gets the parametric_values of this ParametricMaterialProperty. # noqa: E501
- Returns
The parametric_values of this ParametricMaterialProperty. # noqa: E501
- Return type
list[dict(str, object)]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this ParametricMaterialProperty. # noqa: E501
The material property unit # noqa: E501
- Returns
The unit of this ParametricMaterialProperty. # noqa: E501
- Return type
str
- property value_type¶
Gets the value_type of this ParametricMaterialProperty. # noqa: E501
- Returns
The value_type of this ParametricMaterialProperty. # noqa: E501
- Return type
str
simscale_sdk.models.part module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.part.Part(part_identifier=None, opacity=1.0, render_mode=None, solid_color=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'opacity': 'opacity', 'part_identifier': 'partIdentifier', 'render_mode': 'renderMode', 'solid_color': 'solidColor'}¶
- property opacity¶
Gets the opacity of this Part. # noqa: E501
- Returns
The opacity of this Part. # noqa: E501
- Return type
float
- openapi_types = {'opacity': 'float', 'part_identifier': 'str', 'render_mode': 'RenderMode', 'solid_color': 'Color'}¶
- property part_identifier¶
Gets the part_identifier of this Part. # noqa: E501
The identifier of the part in the result. # noqa: E501
- Returns
The part_identifier of this Part. # noqa: E501
- Return type
str
- property render_mode¶
Gets the render_mode of this Part. # noqa: E501
- Returns
The render_mode of this Part. # noqa: E501
- Return type
- property solid_color¶
Gets the solid_color of this Part. # noqa: E501
- Returns
The solid_color of this Part. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.partial_vector_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.partial_vector_function.PartialVectorFunction(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'x': 'OneOfPartialVectorFunctionX', 'y': 'OneOfPartialVectorFunctionY', 'z': 'OneOfPartialVectorFunctionZ'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this PartialVectorFunction. # noqa: E501
- Returns
The x of this PartialVectorFunction. # noqa: E501
- Return type
OneOfPartialVectorFunctionX
- property y¶
Gets the y of this PartialVectorFunction. # noqa: E501
- Returns
The y of this PartialVectorFunction. # noqa: E501
- Return type
OneOfPartialVectorFunctionY
- property z¶
Gets the z of this PartialVectorFunction. # noqa: E501
- Returns
The z of this PartialVectorFunction. # noqa: E501
- Return type
OneOfPartialVectorFunctionZ
simscale_sdk.models.particle_trace module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.particle_trace.ParticleTrace(seed_settings=None, visualization_style=None, trace_both_directions=True, scalar_field=None, solid_color=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'scalar_field': 'scalarField', 'seed_settings': 'seedSettings', 'solid_color': 'solidColor', 'trace_both_directions': 'traceBothDirections', 'visualization_style': 'visualizationStyle'}¶
- openapi_types = {'scalar_field': 'ScalarField', 'seed_settings': 'SeedSettings', 'solid_color': 'Color', 'trace_both_directions': 'bool', 'visualization_style': 'OneOfVisualizationStyle'}¶
- property scalar_field¶
Gets the scalar_field of this ParticleTrace. # noqa: E501
- Returns
The scalar_field of this ParticleTrace. # noqa: E501
- Return type
- property seed_settings¶
Gets the seed_settings of this ParticleTrace. # noqa: E501
- Returns
The seed_settings of this ParticleTrace. # noqa: E501
- Return type
- property solid_color¶
Gets the solid_color of this ParticleTrace. # noqa: E501
- Returns
The solid_color of this ParticleTrace. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property trace_both_directions¶
Gets the trace_both_directions of this ParticleTrace. # noqa: E501
If set to true, the trace will be computed both forwards and backwards from the seed points. # noqa: E501
- Returns
The trace_both_directions of this ParticleTrace. # noqa: E501
- Return type
bool
- property visualization_style¶
Gets the visualization_style of this ParticleTrace. # noqa: E501
- Returns
The visualization_style of this ParticleTrace. # noqa: E501
- Return type
OneOfVisualizationStyle
simscale_sdk.models.particle_trace_animation_output_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.particle_trace_animation_output_settings.ParticleTraceAnimationOutputSettings(name=None, format='GIF', resolution=None, frame_rate=20, show_legend=True, show_cube=True, background_color=None, type='PARTICLE_TRACE', frame_index=None, steps=300, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'background_color': 'backgroundColor', 'format': 'format', 'frame_index': 'frameIndex', 'frame_rate': 'frameRate', 'name': 'name', 'resolution': 'resolution', 'show_cube': 'showCube', 'show_legend': 'showLegend', 'steps': 'steps', 'type': 'type'}¶
- property background_color¶
Gets the background_color of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The background_color of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
- property format¶
Gets the format of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The format of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
str
- property frame_index¶
Gets the frame_index of this ParticleTraceAnimationOutputSettings. # noqa: E501
Default is the last frame (time step) in the result. # noqa: E501
- Returns
The frame_index of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
int
- property frame_rate¶
Gets the frame_rate of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The frame_rate of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
int
- property name¶
Gets the name of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The name of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
str
- openapi_types = {'background_color': 'Color', 'format': 'str', 'frame_index': 'int', 'frame_rate': 'int', 'name': 'str', 'resolution': 'ResolutionInfo', 'show_cube': 'bool', 'show_legend': 'bool', 'steps': 'int', 'type': 'str'}¶
- property resolution¶
Gets the resolution of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The resolution of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
- property show_cube¶
Gets the show_cube of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The show_cube of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
bool
- property show_legend¶
Gets the show_legend of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The show_legend of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
bool
- property steps¶
Gets the steps of this ParticleTraceAnimationOutputSettings. # noqa: E501
The number of steps to generate for the particle trace animation. # noqa: E501
- Returns
The steps of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Returns
The type of this ParticleTraceAnimationOutputSettings. # noqa: E501
- Return type
str
simscale_sdk.models.particle_trace_animation_output_settings_all_of module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.particle_trace_animation_output_settings_all_of.ParticleTraceAnimationOutputSettingsAllOf(type='PARTICLE_TRACE', frame_index=None, steps=300, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'frame_index': 'frameIndex', 'steps': 'steps', 'type': 'type'}¶
- property frame_index¶
Gets the frame_index of this ParticleTraceAnimationOutputSettingsAllOf. # noqa: E501
Default is the last frame (time step) in the result. # noqa: E501
- Returns
The frame_index of this ParticleTraceAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- openapi_types = {'frame_index': 'int', 'steps': 'int', 'type': 'str'}¶
- property steps¶
Gets the steps of this ParticleTraceAnimationOutputSettingsAllOf. # noqa: E501
The number of steps to generate for the particle trace animation. # noqa: E501
- Returns
The steps of this ParticleTraceAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ParticleTraceAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The type of this ParticleTraceAnimationOutputSettingsAllOf. # noqa: E501
- Return type
str
simscale_sdk.models.pbicg_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pbicg_solver.PBICGSolver(type='PBICG', absolute_tolerance=None, relative_tolerance=None, preconditioner=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property absolute_tolerance¶
Gets the absolute_tolerance of this PBICGSolver. # noqa: E501
<p>Define the absolute tolerance for the residual. The convergence process will be stopped as soon as the residual falls below the absolute tolerance.</p> # noqa: E501
- Returns
The absolute_tolerance of this PBICGSolver. # noqa: E501
- Return type
float
- attribute_map = {'absolute_tolerance': 'absoluteTolerance', 'preconditioner': 'preconditioner', 'relative_tolerance': 'relativeTolerance', 'type': 'type'}¶
- openapi_types = {'absolute_tolerance': 'float', 'preconditioner': 'OneOfPBICGSolverPreconditioner', 'relative_tolerance': 'float', 'type': 'str'}¶
- property preconditioner¶
Gets the preconditioner of this PBICGSolver. # noqa: E501
- Returns
The preconditioner of this PBICGSolver. # noqa: E501
- Return type
OneOfPBICGSolverPreconditioner
- property relative_tolerance¶
Gets the relative_tolerance of this PBICGSolver. # noqa: E501
<p>Choose the relative tolerance for the residual. The convergence process will be stopped as soon as the ratio of current to initial residual falls below the relative tolerance.</p> # noqa: E501
- Returns
The relative_tolerance of this PBICGSolver. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PBICGSolver. # noqa: E501
Schema name: PBICGSolver # noqa: E501
- Returns
The type of this PBICGSolver. # noqa: E501
- Return type
str
simscale_sdk.models.pcg_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pcg_solver.PCGSolver(type='PCG', absolute_tolerance=None, relative_tolerance=None, preconditioner=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property absolute_tolerance¶
Gets the absolute_tolerance of this PCGSolver. # noqa: E501
<p>Define the absolute tolerance for the residual. The convergence process will be stopped as soon as the residual falls below the absolute tolerance.</p> # noqa: E501
- Returns
The absolute_tolerance of this PCGSolver. # noqa: E501
- Return type
float
- attribute_map = {'absolute_tolerance': 'absoluteTolerance', 'preconditioner': 'preconditioner', 'relative_tolerance': 'relativeTolerance', 'type': 'type'}¶
- openapi_types = {'absolute_tolerance': 'float', 'preconditioner': 'OneOfPCGSolverPreconditioner', 'relative_tolerance': 'float', 'type': 'str'}¶
- property preconditioner¶
Gets the preconditioner of this PCGSolver. # noqa: E501
- Returns
The preconditioner of this PCGSolver. # noqa: E501
- Return type
OneOfPCGSolverPreconditioner
- property relative_tolerance¶
Gets the relative_tolerance of this PCGSolver. # noqa: E501
<p>Choose the relative tolerance for the residual. The convergence process will be stopped as soon as the ratio of current to initial residual falls below the relative tolerance.</p> # noqa: E501
- Returns
The relative_tolerance of this PCGSolver. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PCGSolver. # noqa: E501
Schema name: PCGSolver # noqa: E501
- Returns
The type of this PCGSolver. # noqa: E501
- Return type
str
simscale_sdk.models.pedestrian_comfort_surface module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pedestrian_comfort_surface.PedestrianComfortSurface(name=None, height_above_ground=None, ground=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'ground': 'ground', 'height_above_ground': 'heightAboveGround', 'name': 'name'}¶
- property ground¶
Gets the ground of this PedestrianComfortSurface. # noqa: E501
- Returns
The ground of this PedestrianComfortSurface. # noqa: E501
- Return type
OneOfPedestrianComfortSurfaceGround
- property height_above_ground¶
Gets the height_above_ground of this PedestrianComfortSurface. # noqa: E501
- Returns
The height_above_ground of this PedestrianComfortSurface. # noqa: E501
- Return type
- property name¶
Gets the name of this PedestrianComfortSurface. # noqa: E501
- Returns
The name of this PedestrianComfortSurface. # noqa: E501
- Return type
str
- openapi_types = {'ground': 'OneOfPedestrianComfortSurfaceGround', 'height_above_ground': 'DimensionalLength', 'name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.penalty_method module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.penalty_method.PenaltyMethod(type='PENALTY_METHOD', penalty_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'penalty_coefficient': 'penaltyCoefficient', 'type': 'type'}¶
- openapi_types = {'penalty_coefficient': 'float', 'type': 'str'}¶
- property penalty_coefficient¶
Gets the penalty_coefficient of this PenaltyMethod. # noqa: E501
- Returns
The penalty_coefficient of this PenaltyMethod. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PenaltyMethod. # noqa: E501
Schema name: PenaltyMethod # noqa: E501
- Returns
The type of this PenaltyMethod. # noqa: E501
- Return type
str
simscale_sdk.models.peng_robinson_gas_equation_of_state module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.peng_robinson_gas_equation_of_state.PengRobinsonGasEquationOfState(type='PENG_ROBINSON_GAS', critical_temperature=None, critical_volume=None, critical_pressure=None, acentric_factor=None, energy=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property acentric_factor¶
Gets the acentric_factor of this PengRobinsonGasEquationOfState. # noqa: E501
Specify the acentric factor. It is a property of the material that characterized the changes in thermodynamic properties of the fluid due to non-spherical molecules. # noqa: E501
- Returns
The acentric_factor of this PengRobinsonGasEquationOfState. # noqa: E501
- Return type
float
- attribute_map = {'acentric_factor': 'acentricFactor', 'critical_pressure': 'criticalPressure', 'critical_temperature': 'criticalTemperature', 'critical_volume': 'criticalVolume', 'energy': 'energy', 'type': 'type'}¶
- property critical_pressure¶
Gets the critical_pressure of this PengRobinsonGasEquationOfState. # noqa: E501
- Returns
The critical_pressure of this PengRobinsonGasEquationOfState. # noqa: E501
- Return type
- property critical_temperature¶
Gets the critical_temperature of this PengRobinsonGasEquationOfState. # noqa: E501
- Returns
The critical_temperature of this PengRobinsonGasEquationOfState. # noqa: E501
- Return type
- property critical_volume¶
Gets the critical_volume of this PengRobinsonGasEquationOfState. # noqa: E501
- Returns
The critical_volume of this PengRobinsonGasEquationOfState. # noqa: E501
- Return type
- property energy¶
Gets the energy of this PengRobinsonGasEquationOfState. # noqa: E501
<p><b>Energy</b> provides the methods for the form of energy to be used. The options are:</p><p><b>Sensible enthalpy:</b> The enthalpy form of equation is used without the heat of formation. In most cases this is the recommended choice.</p><p><b>Sensible internal Energy:</b> The internal energy form of equation is used without the heat of formation but also incorporates energy change due to reactions.</p> # noqa: E501
- Returns
The energy of this PengRobinsonGasEquationOfState. # noqa: E501
- Return type
str
- openapi_types = {'acentric_factor': 'float', 'critical_pressure': 'DimensionalPressure', 'critical_temperature': 'DimensionalTemperature', 'critical_volume': 'DimensionalMolarMass', 'energy': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PengRobinsonGasEquationOfState. # noqa: E501
<br><p>The <b>Equation of state</b> describes the relation between density of a fluid and the fluid pressure and temperature. The available options are:</p><p><b>Rho const:</b> Fluid density is assumed constant.</p><p><b>Incompressibel perfect gas:</b> The fluid is assumed to be an ‘Ideal Gas’ that is incompressible by pressure. But, fluid density can change due to temperature.</p><p><b>Perfect gas:</b> Fluid is assumed to be an ‘Ideal Gas’ and obeys the ‘Ideal Gas Law’.</p><p><b>Perfect fluid:</b> Fluid density can change due to pressure and temperature with respect to a base value.</p><p><b>Adiabatic perfect fluid:</b> The fluid is a perfect fluid which is adiabatic in nature.</p> <a href=’https://www.simscale.com/docs/simulation-setup/materials/thermophysical-fluid-models/#equation-of-state’ target=’_blank’>Learn more</a>. Schema name: PengRobinsonGasEquationOfState # noqa: E501
- Returns
The type of this PengRobinsonGasEquationOfState. # noqa: E501
- Return type
str
simscale_sdk.models.perfect_fluid_equation_of_state module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.perfect_fluid_equation_of_state.PerfectFluidEquationOfState(type='PERFECT_FLUID', fluid_constant=None, reference_density=None, energy=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'energy': 'energy', 'fluid_constant': 'fluidConstant', 'reference_density': 'referenceDensity', 'type': 'type'}¶
- property energy¶
Gets the energy of this PerfectFluidEquationOfState. # noqa: E501
<p><b>Energy</b> provides the methods for the form of energy to be used. The options are:</p><p><b>Sensible enthalpy:</b> The enthalpy form of equation is used without the heat of formation. In most cases this is the recommended choice.</p><p><b>Sensible internal Energy:</b> The internal energy form of equation is used without the heat of formation but also incorporates energy change due to reactions.</p> # noqa: E501
- Returns
The energy of this PerfectFluidEquationOfState. # noqa: E501
- Return type
str
- property fluid_constant¶
Gets the fluid_constant of this PerfectFluidEquationOfState. # noqa: E501
- Returns
The fluid_constant of this PerfectFluidEquationOfState. # noqa: E501
- Return type
- openapi_types = {'energy': 'str', 'fluid_constant': 'DimensionalSpecificHeat', 'reference_density': 'DimensionalDensity', 'type': 'str'}¶
- property reference_density¶
Gets the reference_density of this PerfectFluidEquationOfState. # noqa: E501
- Returns
The reference_density of this PerfectFluidEquationOfState. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PerfectFluidEquationOfState. # noqa: E501
<br><p>The <b>Equation of state</b> describes the relation between density of a fluid and the fluid pressure and temperature. The available options are:</p><p><b>Rho const:</b> Fluid density is assumed constant.</p><p><b>Incompressibel perfect gas:</b> The fluid is assumed to be an ‘Ideal Gas’ that is incompressible by pressure. But, fluid density can change due to temperature.</p><p><b>Perfect gas:</b> Fluid is assumed to be an ‘Ideal Gas’ and obeys the ‘Ideal Gas Law’.</p><p><b>Perfect fluid:</b> Fluid density can change due to pressure and temperature with respect to a base value.</p><p><b>Adiabatic perfect fluid:</b> The fluid is a perfect fluid which is adiabatic in nature.</p> <a href=’https://www.simscale.com/docs/simulation-setup/materials/thermophysical-fluid-models/#equation-of-state’ target=’_blank’>Learn more</a>. Schema name: PerfectFluidEquationOfState # noqa: E501
- Returns
The type of this PerfectFluidEquationOfState. # noqa: E501
- Return type
str
simscale_sdk.models.perfect_gas_equation_of_state module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.perfect_gas_equation_of_state.PerfectGasEquationOfState(type='PERFECT_GAS', energy=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'energy': 'energy', 'type': 'type'}¶
- property energy¶
Gets the energy of this PerfectGasEquationOfState. # noqa: E501
<p><b>Energy</b> provides the methods for the form of energy to be used. The options are:</p><p><b>Sensible enthalpy:</b> The enthalpy form of equation is used without the heat of formation. In most cases this is the recommended choice.</p><p><b>Sensible internal Energy:</b> The internal energy form of equation is used without the heat of formation but also incorporates energy change due to reactions.</p> # noqa: E501
- Returns
The energy of this PerfectGasEquationOfState. # noqa: E501
- Return type
str
- openapi_types = {'energy': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PerfectGasEquationOfState. # noqa: E501
<br><p>The <b>Equation of state</b> describes the relation between density of a fluid and the fluid pressure and temperature. The available options are:</p><p><b>Rho const:</b> Fluid density is assumed constant.</p><p><b>Incompressibel perfect gas:</b> The fluid is assumed to be an ‘Ideal Gas’ that is incompressible by pressure. But, fluid density can change due to temperature.</p><p><b>Perfect gas:</b> Fluid is assumed to be an ‘Ideal Gas’ and obeys the ‘Ideal Gas Law’.</p><p><b>Perfect fluid:</b> Fluid density can change due to pressure and temperature with respect to a base value.</p><p><b>Adiabatic perfect fluid:</b> The fluid is a perfect fluid which is adiabatic in nature.</p> <a href=’https://www.simscale.com/docs/simulation-setup/materials/thermophysical-fluid-models/#equation-of-state’ target=’_blank’>Learn more</a>. Schema name: PerfectGasEquationOfState # noqa: E501
- Returns
The type of this PerfectGasEquationOfState. # noqa: E501
- Return type
str
simscale_sdk.models.perforated_plate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.perforated_plate.PerforatedPlate(type='PERFORATED_PLATE', name=None, plate_data=None, darcy_forchheimer_type=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'darcy_forchheimer_type': 'darcyForchheimerType', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'plate_data': 'plateData', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property darcy_forchheimer_type¶
Gets the darcy_forchheimer_type of this PerforatedPlate. # noqa: E501
- Returns
The darcy_forchheimer_type of this PerforatedPlate. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this PerforatedPlate. # noqa: E501
- Returns
The geometry_primitive_uuids of this PerforatedPlate. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this PerforatedPlate. # noqa: E501
- Returns
The name of this PerforatedPlate. # noqa: E501
- Return type
str
- openapi_types = {'darcy_forchheimer_type': 'RectifyingDarcyForchheimer', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'plate_data': 'PlateData', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property plate_data¶
Gets the plate_data of this PerforatedPlate. # noqa: E501
- Returns
The plate_data of this PerforatedPlate. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PerforatedPlate. # noqa: E501
- Returns
The topological_reference of this PerforatedPlate. # noqa: E501
- Return type
- property type¶
Gets the type of this PerforatedPlate. # noqa: E501
Schema name: PerforatedPlate # noqa: E501
- Returns
The type of this PerforatedPlate. # noqa: E501
- Return type
str
simscale_sdk.models.periodic_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.periodic_bc.PeriodicBC(type='PERIODIC', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this PeriodicBC. # noqa: E501
- Returns
The name of this PeriodicBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PeriodicBC. # noqa: E501
- Returns
The topological_reference of this PeriodicBC. # noqa: E501
- Return type
- property type¶
Gets the type of this PeriodicBC. # noqa: E501
This boundary condition should be used on two faces of a system as if they are physically connected. It is required that the two faces are of same size and shape and the face elements of the mesh are congruent on both sides. Works for uploaded meshes only. <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/periodic-boundary-condition/’ target=’_blank’>Learn more</a>. Schema name: PeriodicBC # noqa: E501
- Returns
The type of this PeriodicBC. # noqa: E501
- Return type
str
simscale_sdk.models.permission_dto module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.permission_dto.PermissionDto(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- ADMIN = 'ADMIN'¶
- READ = 'READ'¶
- WRITE = 'WRITE'¶
- allowable_values = ['READ', 'WRITE', 'ADMIN']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.petsc_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.petsc_solver.PETSCSolver(type='PETSC', force_symmetric=None, algorithm=None, preconditioner=None, max_iterations=None, convergence_threshold=None, distributed_matrix_storage=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property algorithm¶
Gets the algorithm of this PETSCSolver. # noqa: E501
Choose the iterative solver method: <ul><li><p><b>GMRES</b>: <i>Minimal Generalised RESidual</i>, best compromise between robustness and computational speed.</p></ul><ul><li><p><b>CG</b>: <i>Conjugate Gradient</i>, only useful for symmetric matrices</p></ul><ul><li><p><b>CR</b>: <i>Conjugate Residual</i>, only useful for symmetric matrices</p></ul><ul><li><p><b>GCR</b>: <i>Generalised Conjugate Residual</i>, treats general matrices</p></ul>All available methods are of <i>Krylov</i> type. # noqa: E501
- Returns
The algorithm of this PETSCSolver. # noqa: E501
- Return type
str
- attribute_map = {'algorithm': 'algorithm', 'convergence_threshold': 'convergenceThreshold', 'distributed_matrix_storage': 'distributedMatrixStorage', 'force_symmetric': 'forceSymmetric', 'max_iterations': 'maxIterations', 'preconditioner': 'preconditioner', 'type': 'type'}¶
- property convergence_threshold¶
Gets the convergence_threshold of this PETSCSolver. # noqa: E501
Set the threshold value for convergence detection for the relative convergence criteria. # noqa: E501
- Returns
The convergence_threshold of this PETSCSolver. # noqa: E501
- Return type
float
- property distributed_matrix_storage¶
Gets the distributed_matrix_storage of this PETSCSolver. # noqa: E501
Choose this parameter as <b>true</b> to ensure that the system matrix saving is distributed among the processors of the computation. If multiple cores are used only the relevant part for each core is saved. If it is set to false the whole matrix is saved for each processor. # noqa: E501
- Returns
The distributed_matrix_storage of this PETSCSolver. # noqa: E501
- Return type
bool
- property force_symmetric¶
Gets the force_symmetric of this PETSCSolver. # noqa: E501
Choose if you want to enforce a symmetric matrix. # noqa: E501
- Returns
The force_symmetric of this PETSCSolver. # noqa: E501
- Return type
bool
- property max_iterations¶
Gets the max_iterations of this PETSCSolver. # noqa: E501
Set the maximum number of iterations for the iterative solver. If set to 0 PETSC sets an estimate of the maximum number of iterations. # noqa: E501
- Returns
The max_iterations of this PETSCSolver. # noqa: E501
- Return type
int
- openapi_types = {'algorithm': 'str', 'convergence_threshold': 'float', 'distributed_matrix_storage': 'bool', 'force_symmetric': 'bool', 'max_iterations': 'int', 'preconditioner': 'OneOfPETSCSolverPreconditioner', 'type': 'str'}¶
- property preconditioner¶
Gets the preconditioner of this PETSCSolver. # noqa: E501
- Returns
The preconditioner of this PETSCSolver. # noqa: E501
- Return type
OneOfPETSCSolverPreconditioner
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PETSCSolver. # noqa: E501
<p>Choose a linear equation system solver for your calculation:</p><ul><li><p><b>Multfront</b> is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.</p></ul><ul><li><p><b>MUMPS</b> is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.</p></ul><ul><li><p><b>LDLT</b> is a direct solver which uses a Gaussian Algortihm. It is comparatively slow for big problems.</p></ul><ul><li><p><b>PETSC</b> is an iterative solver specially designed to deal with large systems. It scales very effectively in parallel and is the best choice for large problems.</p></ul><ul><li><p><b>GCPC</b> is an iterative solver of the pre-conditioned conjugate gradient type. It scales well in parallel and is also usable for large problems.</p></ul> Schema name: PETSCSolver # noqa: E501
- Returns
The type of this PETSCSolver. # noqa: E501
- Return type
str
simscale_sdk.models.physical_contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.physical_contact.PhysicalContact(type='PHYSICAL_CONTACT_V36', settings=None, connections=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'connections': 'connections', 'settings': 'settings', 'type': 'type'}¶
- property connections¶
Gets the connections of this PhysicalContact. # noqa: E501
- Returns
The connections of this PhysicalContact. # noqa: E501
- Return type
list[OneOfPhysicalContactConnections]
- openapi_types = {'connections': 'list[OneOfPhysicalContactConnections]', 'settings': 'ConnectionSettingsV36', 'type': 'str'}¶
- property settings¶
Gets the settings of this PhysicalContact. # noqa: E501
- Returns
The settings of this PhysicalContact. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PhysicalContact. # noqa: E501
Schema name: PhysicalContact # noqa: E501
- Returns
The type of this PhysicalContact. # noqa: E501
- Return type
str
simscale_sdk.models.plane_tree module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.plane_tree.PlaneTree(type='PLANE_TREE', average_tree_height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_tree_height': 'averageTreeHeight', 'type': 'type'}¶
- property average_tree_height¶
Gets the average_tree_height of this PlaneTree. # noqa: E501
- Returns
The average_tree_height of this PlaneTree. # noqa: E501
- Return type
- openapi_types = {'average_tree_height': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PlaneTree. # noqa: E501
Schema name: PlaneTree # noqa: E501
- Returns
The type of this PlaneTree. # noqa: E501
- Return type
str
simscale_sdk.models.plastic_material_behavior module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.plastic_material_behavior.PlasticMaterialBehavior(type='PLASTIC', plastic_hardening=None, creep_formulation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'creep_formulation': 'creepFormulation', 'plastic_hardening': 'plasticHardening', 'type': 'type'}¶
- property creep_formulation¶
Gets the creep_formulation of this PlasticMaterialBehavior. # noqa: E501
- Returns
The creep_formulation of this PlasticMaterialBehavior. # noqa: E501
- Return type
OneOfPlasticMaterialBehaviorCreepFormulation
- openapi_types = {'creep_formulation': 'OneOfPlasticMaterialBehaviorCreepFormulation', 'plastic_hardening': 'IsotropicPlasticHardening', 'type': 'str'}¶
- property plastic_hardening¶
Gets the plastic_hardening of this PlasticMaterialBehavior. # noqa: E501
- Returns
The plastic_hardening of this PlasticMaterialBehavior. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PlasticMaterialBehavior. # noqa: E501
<p>Choose the material behavior for your problem. </p> <br /><br />Important remarks:<br /> <ul><li>Choose <b>Linear elastic</b> if the stress-strain relationship of your material is linear.</li><li>Choose <b>Elasto-plastic</b> if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.</li><li>Choose <b>Hyperelastic</b> if your material responds elastically even at higher deformations.</li></ul> Schema name: PlasticMaterialBehavior # noqa: E501
- Returns
The type of this PlasticMaterialBehavior. # noqa: E501
- Return type
str
simscale_sdk.models.plate_data module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.plate_data.PlateData(free_area_ratio=None, hole_shape=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'free_area_ratio': 'freeAreaRatio', 'hole_shape': 'holeShape'}¶
- property free_area_ratio¶
Gets the free_area_ratio of this PlateData. # noqa: E501
Free area ratio is the ratio of open area of the perforated plate to its total area. # noqa: E501
- Returns
The free_area_ratio of this PlateData. # noqa: E501
- Return type
float
- property hole_shape¶
Gets the hole_shape of this PlateData. # noqa: E501
- Returns
The hole_shape of this PlateData. # noqa: E501
- Return type
OneOfPlateDataHoleShape
- openapi_types = {'free_area_ratio': 'float', 'hole_shape': 'OneOfPlateDataHoleShape'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.point module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.point.Point(type='POINT', id=None, name=None, center=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center': 'center', 'id': 'id', 'name': 'name', 'type': 'type'}¶
- property center¶
Gets the center of this Point. # noqa: E501
- Returns
The center of this Point. # noqa: E501
- Return type
- property id¶
Gets the id of this Point. # noqa: E501
- Returns
The id of this Point. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Point. # noqa: E501
- Returns
The name of this Point. # noqa: E501
- Return type
str
- openapi_types = {'center': 'DimensionalVectorLength', 'id': 'str', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Point. # noqa: E501
Schema name: Point # noqa: E501
- Returns
The type of this Point. # noqa: E501
- Return type
str
simscale_sdk.models.point_mass_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.point_mass_bc.PointMassBC(type='POINT_MASS', name=None, mass=None, mass_moment_of_inertia=None, external_point=None, deformation_behavior=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'deformation_behavior': 'deformationBehavior', 'external_point': 'externalPoint', 'mass': 'mass', 'mass_moment_of_inertia': 'massMomentOfInertia', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property deformation_behavior¶
Gets the deformation_behavior of this PointMassBC. # noqa: E501
<p>Choose the deformation behavior of the entity which the point mass is connected to. If <b>deformable</b> is selected, the entity is allowed to deform, selecting <b>undeformable</b> leads to a rigid entity.</p> # noqa: E501
- Returns
The deformation_behavior of this PointMassBC. # noqa: E501
- Return type
str
- property external_point¶
Gets the external_point of this PointMassBC. # noqa: E501
- Returns
The external_point of this PointMassBC. # noqa: E501
- Return type
- property mass¶
Gets the mass of this PointMassBC. # noqa: E501
- Returns
The mass of this PointMassBC. # noqa: E501
- Return type
- property mass_moment_of_inertia¶
Gets the mass_moment_of_inertia of this PointMassBC. # noqa: E501
- Returns
The mass_moment_of_inertia of this PointMassBC. # noqa: E501
- Return type
- property name¶
Gets the name of this PointMassBC. # noqa: E501
- Returns
The name of this PointMassBC. # noqa: E501
- Return type
str
- openapi_types = {'deformation_behavior': 'str', 'external_point': 'DimensionalVectorLength', 'mass': 'DimensionalMass', 'mass_moment_of_inertia': 'DimensionalVectorMomentOfInertia', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PointMassBC. # noqa: E501
- Returns
The topological_reference of this PointMassBC. # noqa: E501
- Return type
- property type¶
Gets the type of this PointMassBC. # noqa: E501
<p>Define a <b>Point mass</b> boundary condition in order to insert an additional mass on a specific location of the active model.</p> Schema name: PointMassBC # noqa: E501
- Returns
The type of this PointMassBC. # noqa: E501
- Return type
str
simscale_sdk.models.polynomial_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.polynomial_function.PolynomialFunction(type='POLYNOMIAL', coefficients=None, parameter_base_unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'coefficients': 'coefficients', 'parameter_base_unit': 'parameterBaseUnit', 'type': 'type'}¶
- property coefficients¶
Gets the coefficients of this PolynomialFunction. # noqa: E501
- Returns
The coefficients of this PolynomialFunction. # noqa: E501
- Return type
list[float]
- openapi_types = {'coefficients': 'list[float]', 'parameter_base_unit': 'str', 'type': 'str'}¶
- property parameter_base_unit¶
Gets the parameter_base_unit of this PolynomialFunction. # noqa: E501
- Returns
The parameter_base_unit of this PolynomialFunction. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PolynomialFunction. # noqa: E501
Schema name: PolynomialFunction # noqa: E501
- Returns
The type of this PolynomialFunction. # noqa: E501
- Return type
str
simscale_sdk.models.porous_tree module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.porous_tree.PorousTree(type='POROUS_TREE', name=None, tree_type=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'topological_reference': 'topologicalReference', 'tree_type': 'treeType', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this PorousTree. # noqa: E501
- Returns
The geometry_primitive_uuids of this PorousTree. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this PorousTree. # noqa: E501
- Returns
The name of this PorousTree. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'topological_reference': 'TopologicalReference', 'tree_type': 'OneOfPorousTreeTreeType', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PorousTree. # noqa: E501
- Returns
The topological_reference of this PorousTree. # noqa: E501
- Return type
- property tree_type¶
Gets the tree_type of this PorousTree. # noqa: E501
- Returns
The tree_type of this PorousTree. # noqa: E501
- Return type
OneOfPorousTreeTreeType
- property type¶
Gets the type of this PorousTree. # noqa: E501
Schema name: PorousTree # noqa: E501
- Returns
The type of this PorousTree. # noqa: E501
- Return type
str
simscale_sdk.models.power_heat_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.power_heat_source.PowerHeatSource(type='POWER', power=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'power': 'power', 'type': 'type'}¶
- openapi_types = {'power': 'DimensionalPower', 'type': 'str'}¶
- property power¶
Gets the power of this PowerHeatSource. # noqa: E501
- Returns
The power of this PowerHeatSource. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PowerHeatSource. # noqa: E501
Schema name: PowerHeatSource # noqa: E501
- Returns
The type of this PowerHeatSource. # noqa: E501
- Return type
str
simscale_sdk.models.power_law_medium module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.power_law_medium.PowerLawMedium(type='POWER_LAW', name=None, linear_coefficient=None, exponent_coefficient=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'exponent_coefficient': 'exponentCoefficient', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'linear_coefficient': 'linearCoefficient', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property exponent_coefficient¶
Gets the exponent_coefficient of this PowerLawMedium. # noqa: E501
- Returns
The exponent_coefficient of this PowerLawMedium. # noqa: E501
- Return type
float
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this PowerLawMedium. # noqa: E501
- Returns
The geometry_primitive_uuids of this PowerLawMedium. # noqa: E501
- Return type
list[str]
- property linear_coefficient¶
Gets the linear_coefficient of this PowerLawMedium. # noqa: E501
- Returns
The linear_coefficient of this PowerLawMedium. # noqa: E501
- Return type
float
- property name¶
Gets the name of this PowerLawMedium. # noqa: E501
- Returns
The name of this PowerLawMedium. # noqa: E501
- Return type
str
- openapi_types = {'exponent_coefficient': 'float', 'geometry_primitive_uuids': 'list[str]', 'linear_coefficient': 'float', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PowerLawMedium. # noqa: E501
- Returns
The topological_reference of this PowerLawMedium. # noqa: E501
- Return type
- property type¶
Gets the type of this PowerLawMedium. # noqa: E501
Schema name: PowerLawMedium # noqa: E501
- Returns
The type of this PowerLawMedium. # noqa: E501
- Return type
str
simscale_sdk.models.power_law_viscosity_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.power_law_viscosity_model.PowerLawViscosityModel(type='POWER_LAW', k=None, n=None, nu_min=None, nu_max=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'k': 'k', 'n': 'n', 'nu_max': 'nuMax', 'nu_min': 'nuMin', 'type': 'type'}¶
- property k¶
Gets the k of this PowerLawViscosityModel. # noqa: E501
- Returns
The k of this PowerLawViscosityModel. # noqa: E501
- Return type
- property n¶
Gets the n of this PowerLawViscosityModel. # noqa: E501
- Returns
The n of this PowerLawViscosityModel. # noqa: E501
- Return type
- property nu_max¶
Gets the nu_max of this PowerLawViscosityModel. # noqa: E501
- Returns
The nu_max of this PowerLawViscosityModel. # noqa: E501
- Return type
- property nu_min¶
Gets the nu_min of this PowerLawViscosityModel. # noqa: E501
- Returns
The nu_min of this PowerLawViscosityModel. # noqa: E501
- Return type
- openapi_types = {'k': 'DimensionalKinematicViscosity', 'n': 'DimensionalDimensionless', 'nu_max': 'DimensionalKinematicViscosity', 'nu_min': 'DimensionalKinematicViscosity', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PowerLawViscosityModel. # noqa: E501
Choose between <a href=’https://www.simscale.com/docs/simulation-setup/materials/#newtonian-model’ target=’_blank’>Newtonian</a> and <a href=’https://www.simscale.com/docs/simulation-setup/materials/non-newtonian-models/’ target=’_blank’>Non-Newtonian</a> viscosity models. Schema name: PowerLawViscosityModel # noqa: E501
- Returns
The type of this PowerLawViscosityModel. # noqa: E501
- Return type
str
simscale_sdk.models.prandtl_les_delta module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.prandtl_les_delta.PrandtlLesDelta(type='PRANDTL', delta_coefficient=None, delta_reduction_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'delta_coefficient': 'deltaCoefficient', 'delta_reduction_coefficient': 'deltaReductionCoefficient', 'type': 'type'}¶
- property delta_coefficient¶
Gets the delta_coefficient of this PrandtlLesDelta. # noqa: E501
- Returns
The delta_coefficient of this PrandtlLesDelta. # noqa: E501
- Return type
OneOfPrandtlLesDeltaDeltaCoefficient
- property delta_reduction_coefficient¶
Gets the delta_reduction_coefficient of this PrandtlLesDelta. # noqa: E501
- Returns
The delta_reduction_coefficient of this PrandtlLesDelta. # noqa: E501
- Return type
float
- openapi_types = {'delta_coefficient': 'OneOfPrandtlLesDeltaDeltaCoefficient', 'delta_reduction_coefficient': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PrandtlLesDelta. # noqa: E501
Schema name: PrandtlLesDelta # noqa: E501
- Returns
The type of this PrandtlLesDelta. # noqa: E501
- Return type
str
simscale_sdk.models.prescribed_optional_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.prescribed_optional_function.PrescribedOptionalFunction(type='PRESCRIBED', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'OneOfPrescribedOptionalFunctionValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PrescribedOptionalFunction. # noqa: E501
Schema name: PrescribedOptionalFunction # noqa: E501
- Returns
The type of this PrescribedOptionalFunction. # noqa: E501
- Return type
str
- property value¶
Gets the value of this PrescribedOptionalFunction. # noqa: E501
- Returns
The value of this PrescribedOptionalFunction. # noqa: E501
- Return type
OneOfPrescribedOptionalFunctionValue
simscale_sdk.models.pressure_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_bc.PressureBC(type='PRESSURE', name=None, pressure=None, phase_angle=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'phase_angle': 'phaseAngle', 'pressure': 'pressure', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this PressureBC. # noqa: E501
- Returns
The name of this PressureBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'phase_angle': 'DimensionalAngle', 'pressure': 'DimensionalFunctionPressure', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this PressureBC. # noqa: E501
- Returns
The phase_angle of this PressureBC. # noqa: E501
- Return type
- property pressure¶
Gets the pressure of this PressureBC. # noqa: E501
- Returns
The pressure of this PressureBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PressureBC. # noqa: E501
- Returns
The topological_reference of this PressureBC. # noqa: E501
- Return type
- property type¶
Gets the type of this PressureBC. # noqa: E501
This is a <b>pressure</b> boundary condition representing a distributed load on the selection. It is applied normal to the surface of all face elements.<br /><br />Important remarks: <br /><ul><li>The applied total force depends on the surface area of the selection.</li><li>The normal direction of the faces is computed only in the undeformed state and not updated for large deformations.</li><li>For transient analyses you may define a <b>time dependent</b> value by uploading a table (csv-file).</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/pressure/’ target=’_blank’>Learn more</a>. Schema name: PressureBC # noqa: E501
- Returns
The type of this PressureBC. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_coefficient_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_coefficient_result_type.PressureCoefficientResultType(type='PRESSURE_COEFFICIENT', free_stream_pressure=None, free_stream_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'free_stream_pressure': 'freeStreamPressure', 'free_stream_velocity': 'freeStreamVelocity', 'type': 'type'}¶
- property free_stream_pressure¶
Gets the free_stream_pressure of this PressureCoefficientResultType. # noqa: E501
- Returns
The free_stream_pressure of this PressureCoefficientResultType. # noqa: E501
- Return type
- property free_stream_velocity¶
Gets the free_stream_velocity of this PressureCoefficientResultType. # noqa: E501
- Returns
The free_stream_velocity of this PressureCoefficientResultType. # noqa: E501
- Return type
- openapi_types = {'free_stream_pressure': 'DimensionalPressure', 'free_stream_velocity': 'DimensionalVectorSpeed', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PressureCoefficientResultType. # noqa: E501
Schema name: PressureCoefficientResultType # noqa: E501
- Returns
The type of this PressureCoefficientResultType. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_difference_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_difference_result_control.PressureDifferenceResultControl(type='PRESSURE_DIFFERENCE', name=None, inlet_face_topological_reference=None, outlet_face_topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'inlet_face_topological_reference': 'inletFaceTopologicalReference', 'name': 'name', 'outlet_face_topological_reference': 'outletFaceTopologicalReference', 'type': 'type'}¶
- property inlet_face_topological_reference¶
Gets the inlet_face_topological_reference of this PressureDifferenceResultControl. # noqa: E501
- Returns
The inlet_face_topological_reference of this PressureDifferenceResultControl. # noqa: E501
- Return type
- property name¶
Gets the name of this PressureDifferenceResultControl. # noqa: E501
- Returns
The name of this PressureDifferenceResultControl. # noqa: E501
- Return type
str
- openapi_types = {'inlet_face_topological_reference': 'TopologicalReference', 'name': 'str', 'outlet_face_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property outlet_face_topological_reference¶
Gets the outlet_face_topological_reference of this PressureDifferenceResultControl. # noqa: E501
- Returns
The outlet_face_topological_reference of this PressureDifferenceResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PressureDifferenceResultControl. # noqa: E501
Schema name: PressureDifferenceResultControl # noqa: E501
- Returns
The type of this PressureDifferenceResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_inlet_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_inlet_bc.PressureInletBC(type='PRESSURE_INLET_V31', name=None, pressure=None, pressure_rgh=None, gauge_pressure=None, gauge_pressure_rgh=None, temperature=None, passive_scalars=None, phase_fraction=None, net_radiative_heat_flux=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gauge_pressure': 'gaugePressure', 'gauge_pressure_rgh': 'gaugePressureRgh', 'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'passive_scalars': 'passiveScalars', 'phase_fraction': 'phaseFraction', 'pressure': 'pressure', 'pressure_rgh': 'pressureRgh', 'temperature': 'temperature', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property gauge_pressure¶
Gets the gauge_pressure of this PressureInletBC. # noqa: E501
- Returns
The gauge_pressure of this PressureInletBC. # noqa: E501
- Return type
OneOfPressureInletBCGaugePressure
- property gauge_pressure_rgh¶
Gets the gauge_pressure_rgh of this PressureInletBC. # noqa: E501
- Returns
The gauge_pressure_rgh of this PressureInletBC. # noqa: E501
- Return type
- property name¶
Gets the name of this PressureInletBC. # noqa: E501
- Returns
The name of this PressureInletBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this PressureInletBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this PressureInletBC. # noqa: E501
- Return type
OneOfPressureInletBCNetRadiativeHeatFlux
- openapi_types = {'gauge_pressure': 'OneOfPressureInletBCGaugePressure', 'gauge_pressure_rgh': 'TotalPBC', 'name': 'str', 'net_radiative_heat_flux': 'OneOfPressureInletBCNetRadiativeHeatFlux', 'passive_scalars': 'list[FixedValuePSBC]', 'phase_fraction': 'FixedValuePFBC', 'pressure': 'TotalPBC', 'pressure_rgh': 'TotalPBC', 'temperature': 'OneOfPressureInletBCTemperature', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property passive_scalars¶
Gets the passive_scalars of this PressureInletBC. # noqa: E501
Please choose a boundary condition for passive scalar (T). # noqa: E501
- Returns
The passive_scalars of this PressureInletBC. # noqa: E501
- Return type
list[FixedValuePSBC]
- property phase_fraction¶
Gets the phase_fraction of this PressureInletBC. # noqa: E501
- Returns
The phase_fraction of this PressureInletBC. # noqa: E501
- Return type
- property pressure¶
Gets the pressure of this PressureInletBC. # noqa: E501
- Returns
The pressure of this PressureInletBC. # noqa: E501
- Return type
- property pressure_rgh¶
Gets the pressure_rgh of this PressureInletBC. # noqa: E501
- Returns
The pressure_rgh of this PressureInletBC. # noqa: E501
- Return type
- property temperature¶
Gets the temperature of this PressureInletBC. # noqa: E501
- Returns
The temperature of this PressureInletBC. # noqa: E501
- Return type
OneOfPressureInletBCTemperature
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PressureInletBC. # noqa: E501
- Returns
The topological_reference of this PressureInletBC. # noqa: E501
- Return type
- property type¶
Gets the type of this PressureInletBC. # noqa: E501
This boundary condition is suitable for inlet and open boundaries where the value of <b>pressure</b> is known. Schema name: PressureInletBC # noqa: E501
- Returns
The type of this PressureInletBC. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_inlet_outlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_inlet_outlet_vbc.PressureInletOutletVBC(type='PRESSURE_INLET_OUTLET_VELOCITY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PressureInletOutletVBC. # noqa: E501
Schema name: PressureInletOutletVBC # noqa: E501
- Returns
The type of this PressureInletOutletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_inlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_inlet_vbc.PressureInletVBC(type='PRESSURE_INLET_VELOCITY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PressureInletVBC. # noqa: E501
Schema name: PressureInletVBC # noqa: E501
- Returns
The type of this PressureInletVBC. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_loss_curve module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_loss_curve.PressureLossCurve(type='PRESSURE_LOSS_CURVE', name=None, pressure_loss_data=None, directional_dependency=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'directional_dependency': 'directionalDependency', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'pressure_loss_data': 'pressureLossData', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property directional_dependency¶
Gets the directional_dependency of this PressureLossCurve. # noqa: E501
- Returns
The directional_dependency of this PressureLossCurve. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this PressureLossCurve. # noqa: E501
- Returns
The geometry_primitive_uuids of this PressureLossCurve. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this PressureLossCurve. # noqa: E501
- Returns
The name of this PressureLossCurve. # noqa: E501
- Return type
str
- openapi_types = {'directional_dependency': 'DirectionalDependency', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'pressure_loss_data': 'PressureLossData', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property pressure_loss_data¶
Gets the pressure_loss_data of this PressureLossCurve. # noqa: E501
- Returns
The pressure_loss_data of this PressureLossCurve. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PressureLossCurve. # noqa: E501
- Returns
The topological_reference of this PressureLossCurve. # noqa: E501
- Return type
- property type¶
Gets the type of this PressureLossCurve. # noqa: E501
Schema name: PressureLossCurve # noqa: E501
- Returns
The type of this PressureLossCurve. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_loss_data module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_loss_data.PressureLossData(pressure_loss_curve=None, flow_direction_length=None, cross_section_area=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cross_section_area': 'crossSectionArea', 'flow_direction_length': 'flowDirectionLength', 'pressure_loss_curve': 'pressureLossCurve'}¶
- property cross_section_area¶
Gets the cross_section_area of this PressureLossData. # noqa: E501
- Returns
The cross_section_area of this PressureLossData. # noqa: E501
- Return type
- property flow_direction_length¶
Gets the flow_direction_length of this PressureLossData. # noqa: E501
- Returns
The flow_direction_length of this PressureLossData. # noqa: E501
- Return type
- openapi_types = {'cross_section_area': 'DimensionalArea', 'flow_direction_length': 'DimensionalLength', 'pressure_loss_curve': 'DimensionalFunctionPressure'}¶
- property pressure_loss_curve¶
Gets the pressure_loss_curve of this PressureLossData. # noqa: E501
- Returns
The pressure_loss_curve of this PressureLossData. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.pressure_outlet_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_outlet_bc.PressureOutletBC(type='PRESSURE_OUTLET_V30', name=None, pressure=None, pressure_rgh=None, gauge_pressure=None, gauge_pressure_rgh=None, net_radiative_heat_flux=None, radiative_intensity_ray=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'gauge_pressure': 'gaugePressure', 'gauge_pressure_rgh': 'gaugePressureRgh', 'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'pressure': 'pressure', 'pressure_rgh': 'pressureRgh', 'radiative_intensity_ray': 'radiativeIntensityRay', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property gauge_pressure¶
Gets the gauge_pressure of this PressureOutletBC. # noqa: E501
- Returns
The gauge_pressure of this PressureOutletBC. # noqa: E501
- Return type
OneOfPressureOutletBCGaugePressure
- property gauge_pressure_rgh¶
Gets the gauge_pressure_rgh of this PressureOutletBC. # noqa: E501
- Returns
The gauge_pressure_rgh of this PressureOutletBC. # noqa: E501
- Return type
OneOfPressureOutletBCGaugePressureRgh
- property name¶
Gets the name of this PressureOutletBC. # noqa: E501
- Returns
The name of this PressureOutletBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this PressureOutletBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this PressureOutletBC. # noqa: E501
- Return type
OneOfPressureOutletBCNetRadiativeHeatFlux
- openapi_types = {'gauge_pressure': 'OneOfPressureOutletBCGaugePressure', 'gauge_pressure_rgh': 'OneOfPressureOutletBCGaugePressureRgh', 'name': 'str', 'net_radiative_heat_flux': 'OneOfPressureOutletBCNetRadiativeHeatFlux', 'pressure': 'OneOfPressureOutletBCPressure', 'pressure_rgh': 'OneOfPressureOutletBCPressureRgh', 'radiative_intensity_ray': 'OneOfPressureOutletBCRadiativeIntensityRay', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property pressure¶
Gets the pressure of this PressureOutletBC. # noqa: E501
- Returns
The pressure of this PressureOutletBC. # noqa: E501
- Return type
OneOfPressureOutletBCPressure
- property pressure_rgh¶
Gets the pressure_rgh of this PressureOutletBC. # noqa: E501
- Returns
The pressure_rgh of this PressureOutletBC. # noqa: E501
- Return type
OneOfPressureOutletBCPressureRgh
- property radiative_intensity_ray¶
Gets the radiative_intensity_ray of this PressureOutletBC. # noqa: E501
- Returns
The radiative_intensity_ray of this PressureOutletBC. # noqa: E501
- Return type
OneOfPressureOutletBCRadiativeIntensityRay
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this PressureOutletBC. # noqa: E501
- Returns
The topological_reference of this PressureOutletBC. # noqa: E501
- Return type
- property type¶
Gets the type of this PressureOutletBC. # noqa: E501
This boundary condition allows to specify a <b>pressure</b> value at an outlet boundary. Schema name: PressureOutletBC # noqa: E501
- Returns
The type of this PressureOutletBC. # noqa: E501
- Return type
str
simscale_sdk.models.pressure_value_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.pressure_value_result_type.PressureValueResultType(type='PRESSURE_VALUE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PressureValueResultType. # noqa: E501
Schema name: PressureValueResultType # noqa: E501
- Returns
The type of this PressureValueResultType. # noqa: E501
- Return type
str
simscale_sdk.models.principal_green_lagrange_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.principal_green_lagrange_strain_type.PrincipalGreenLagrangeStrainType(type='PRINCIPAL_GREEN_LAGRANGE', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this PrincipalGreenLagrangeStrainType. # noqa: E501
- Returns
The component_selection of this PrincipalGreenLagrangeStrainType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PrincipalGreenLagrangeStrainType. # noqa: E501
Schema name: PrincipalGreenLagrangeStrainType # noqa: E501
- Returns
The type of this PrincipalGreenLagrangeStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.principal_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.principal_strain_type.PrincipalStrainType(type='PRINCIPAL', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this PrincipalStrainType. # noqa: E501
- Returns
The component_selection of this PrincipalStrainType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PrincipalStrainType. # noqa: E501
Schema name: PrincipalStrainType # noqa: E501
- Returns
The type of this PrincipalStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.principal_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.principal_stress_type.PrincipalStressType(type='PRINCIPAL', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this PrincipalStressType. # noqa: E501
- Returns
The component_selection of this PrincipalStressType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this PrincipalStressType. # noqa: E501
Schema name: PrincipalStressType # noqa: E501
- Returns
The type of this PrincipalStressType. # noqa: E501
- Return type
str
simscale_sdk.models.probe_points_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.probe_points_result_control.ProbePointsResultControl(type='PROBE_POINTS', name=None, write_control=None, fraction_from_end=None, export_statistics=None, geometry_primitive_uuids=None, probe_locations=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'export_statistics': 'exportStatistics', 'fraction_from_end': 'fractionFromEnd', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'probe_locations': 'probeLocations', 'type': 'type', 'write_control': 'writeControl'}¶
- property export_statistics¶
Gets the export_statistics of this ProbePointsResultControl. # noqa: E501
<p>When this switch is active, statistical data for the selected probe points will be exported:</p><ul><li>Minimum (<strong>MIN</strong>)</li><li>Maximum (<strong>MAX</strong>)</li><li>Absolute minimum (<strong>MIN (Abs)</strong>)</li><li>Absolute maximum (<strong>MAX (Abs)</strong>)</li><li>Average (<strong>AVG</strong>)</li><li>Standard deviation (<strong>STDDEV</strong>)</li><li>Root mean square (<strong>RMS (fluctuation)</strong>)</li></ul> # noqa: E501
- Returns
The export_statistics of this ProbePointsResultControl. # noqa: E501
- Return type
bool
- property fraction_from_end¶
Gets the fraction_from_end of this ProbePointsResultControl. # noqa: E501
It defines the point in simulation where the result output data extraction starts. For instance, <i>Fraction from end</i> of 1 (100%) extracts all data from the beginning of the simulation while default 0.2 extracts 20% data from the end of the simulation. # noqa: E501
- Returns
The fraction_from_end of this ProbePointsResultControl. # noqa: E501
- Return type
float
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this ProbePointsResultControl. # noqa: E501
- Returns
The geometry_primitive_uuids of this ProbePointsResultControl. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this ProbePointsResultControl. # noqa: E501
- Returns
The name of this ProbePointsResultControl. # noqa: E501
- Return type
str
- openapi_types = {'export_statistics': 'bool', 'fraction_from_end': 'float', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'probe_locations': 'TableDefinedProbeLocations', 'type': 'str', 'write_control': 'OneOfProbePointsResultControlWriteControl'}¶
- property probe_locations¶
Gets the probe_locations of this ProbePointsResultControl. # noqa: E501
- Returns
The probe_locations of this ProbePointsResultControl. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ProbePointsResultControl. # noqa: E501
Schema name: ProbePointsResultControl # noqa: E501
- Returns
The type of this ProbePointsResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this ProbePointsResultControl. # noqa: E501
- Returns
The write_control of this ProbePointsResultControl. # noqa: E501
- Return type
OneOfProbePointsResultControlWriteControl
simscale_sdk.models.project module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.project.Project(project_id=None, created_at=None, name=None, description=None, measurement_system='SI', tags=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'description': 'description', 'measurement_system': 'measurementSystem', 'name': 'name', 'project_id': 'projectId', 'tags': 'tags'}¶
- property created_at¶
Gets the created_at of this Project. # noqa: E501
- Returns
The created_at of this Project. # noqa: E501
- Return type
datetime
- property description¶
Gets the description of this Project. # noqa: E501
A meaningful description of the project. # noqa: E501
- Returns
The description of this Project. # noqa: E501
- Return type
str
- property measurement_system¶
Gets the measurement_system of this Project. # noqa: E501
The measurement system of the project. Can’t be modifed. # noqa: E501
- Returns
The measurement_system of this Project. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Project. # noqa: E501
The project title should contain the application you want to analyze as well as the simulation method you want to use, e.g. ‘Heat exchanger - CHT simulation’. # noqa: E501
- Returns
The name of this Project. # noqa: E501
- Return type
str
- openapi_types = {'created_at': 'datetime', 'description': 'str', 'measurement_system': 'str', 'name': 'str', 'project_id': 'str', 'tags': 'list[str]'}¶
- property project_id¶
Gets the project_id of this Project. # noqa: E501
- Returns
The project_id of this Project. # noqa: E501
- Return type
str
- property tags¶
Gets the tags of this Project. # noqa: E501
- Returns
The tags of this Project. # noqa: E501
- Return type
list[str]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.projection_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.projection_type.ProjectionType(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- ORTHOGONAL = 'ORTHOGONAL'¶
- PERSPECTIVE = 'PERSPECTIVE'¶
- allowable_values = ['ORTHOGONAL', 'PERSPECTIVE']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.projects module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.projects.Projects(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this Projects. # noqa: E501
- Returns
The embedded of this Projects. # noqa: E501
- Return type
list[Project]
- property links¶
Gets the links of this Projects. # noqa: E501
- Returns
The links of this Projects. # noqa: E501
- Return type
- property meta¶
Gets the meta of this Projects. # noqa: E501
- Returns
The meta of this Projects. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[Project]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.property_data_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.property_data_type.PropertyDataType(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- NUMERIC = 'numeric'¶
- STRING = 'string'¶
- allowable_values = ['numeric', 'string']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.qz module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.qz.QZ(type='QZ', type_qz=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'type_qz': 'typeQZ'}¶
- openapi_types = {'type': 'str', 'type_qz': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this QZ. # noqa: E501
Schema name: QZ # noqa: E501
- Returns
The type of this QZ. # noqa: E501
- Return type
str
- property type_qz¶
Gets the type_qz of this QZ. # noqa: E501
- Returns
The type_qz of this QZ. # noqa: E501
- Return type
str
simscale_sdk.models.rayleigh_damping module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rayleigh_damping.RayleighDamping(type='RAYLEIGH', stiffness_proportional_coefficient=None, mass_proportional_coefficient=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'mass_proportional_coefficient': 'massProportionalCoefficient', 'stiffness_proportional_coefficient': 'stiffnessProportionalCoefficient', 'type': 'type'}¶
- property mass_proportional_coefficient¶
Gets the mass_proportional_coefficient of this RayleighDamping. # noqa: E501
- Returns
The mass_proportional_coefficient of this RayleighDamping. # noqa: E501
- Return type
- openapi_types = {'mass_proportional_coefficient': 'DimensionalFrequency', 'stiffness_proportional_coefficient': 'DimensionalTime', 'type': 'str'}¶
- property stiffness_proportional_coefficient¶
Gets the stiffness_proportional_coefficient of this RayleighDamping. # noqa: E501
- Returns
The stiffness_proportional_coefficient of this RayleighDamping. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RayleighDamping. # noqa: E501
<p>Choose if damping effects should be considered. The supported damping types are:<ul><li><p><b>Rayleigh Damping</b> which is also known as <i>proportional viscous damping</i>. This model assumes that the damping is proportional to the vibrating velocity.</p></ul><ul><li><p><b>Hysteretic Damping</b>, also known as <i>structural damping</i>. Here the damping is assumed to be proportional to the displacement.</p></ul><br><a href= https://www.simscale.com/docs/simulation-setup/materials/damping/’ target=’_blank’>Learn more</a>. Schema name: RayleighDamping # noqa: E501
- Returns
The type of this RayleighDamping. # noqa: E501
- Return type
str
simscale_sdk.models.reaction_force_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.reaction_force_type.ReactionForceType(type='REACTION', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this ReactionForceType. # noqa: E501
- Returns
The component_selection of this ReactionForceType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ReactionForceType. # noqa: E501
Schema name: ReactionForceType # noqa: E501
- Returns
The type of this ReactionForceType. # noqa: E501
- Return type
str
simscale_sdk.models.reaction_moment_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.reaction_moment_type.ReactionMomentType(type='REACTION', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this ReactionMomentType. # noqa: E501
- Returns
The component_selection of this ReactionMomentType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ReactionMomentType. # noqa: E501
Schema name: ReactionMomentType # noqa: E501
- Returns
The type of this ReactionMomentType. # noqa: E501
- Return type
str
simscale_sdk.models.rectifying_darcy_forchheimer module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rectifying_darcy_forchheimer.RectifyingDarcyForchheimer(type='RECTIFYING', direction=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'direction': 'direction', 'type': 'type'}¶
- property direction¶
Gets the direction of this RectifyingDarcyForchheimer. # noqa: E501
- Returns
The direction of this RectifyingDarcyForchheimer. # noqa: E501
- Return type
- openapi_types = {'direction': 'DimensionalVectorLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RectifyingDarcyForchheimer. # noqa: E501
Directional porous object where the permeability and friction form coefficient are applied only in the specified direction. For directions orthogonal to the specified direction, the permeability is set to zero, i.e. there is no flow in the orthogonal directions. Schema name: RectifyingDarcyForchheimer # noqa: E501
- Returns
The type of this RectifyingDarcyForchheimer. # noqa: E501
- Return type
str
simscale_sdk.models.refinement_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.refinement_length.RefinementLength(distance=None, length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distance': 'distance', 'length': 'length'}¶
- property distance¶
Gets the distance of this RefinementLength. # noqa: E501
- Returns
The distance of this RefinementLength. # noqa: E501
- Return type
- property length¶
Gets the length of this RefinementLength. # noqa: E501
- Returns
The length of this RefinementLength. # noqa: E501
- Return type
- openapi_types = {'distance': 'DimensionalLength', 'length': 'DimensionalLength'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.refinement_level module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.refinement_level.RefinementLevel(distance=None, level=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'distance': 'distance', 'level': 'level'}¶
- property distance¶
Gets the distance of this RefinementLevel. # noqa: E501
- Returns
The distance of this RefinementLevel. # noqa: E501
- Return type
- property level¶
Gets the level of this RefinementLevel. # noqa: E501
- Returns
The level of this RefinementLevel. # noqa: E501
- Return type
int
- openapi_types = {'distance': 'DimensionalLength', 'level': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.region module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region.Region(type='REGION', geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this Region. # noqa: E501
- Returns
The geometry_primitive_uuids of this Region. # noqa: E501
- Return type
list[str]
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Region. # noqa: E501
Schema name: Region # noqa: E501
- Returns
The type of this Region. # noqa: E501
- Return type
str
simscale_sdk.models.region_interface module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_interface.RegionInterface(type='REGION_INTERFACE', name=None, interface_thermal=None, master_topological_reference=None, slave_topological_reference=None, is_partial=None, custom_modified=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'custom_modified': 'customModified', 'interface_thermal': 'interfaceThermal', 'is_partial': 'isPartial', 'master_topological_reference': 'masterTopologicalReference', 'name': 'name', 'slave_topological_reference': 'slaveTopologicalReference', 'type': 'type'}¶
- property custom_modified¶
Gets the custom_modified of this RegionInterface. # noqa: E501
- Returns
The custom_modified of this RegionInterface. # noqa: E501
- Return type
bool
- property interface_thermal¶
Gets the interface_thermal of this RegionInterface. # noqa: E501
- Returns
The interface_thermal of this RegionInterface. # noqa: E501
- Return type
OneOfRegionInterfaceInterfaceThermal
- property is_partial¶
Gets the is_partial of this RegionInterface. # noqa: E501
- Returns
The is_partial of this RegionInterface. # noqa: E501
- Return type
bool
- property master_topological_reference¶
Gets the master_topological_reference of this RegionInterface. # noqa: E501
- Returns
The master_topological_reference of this RegionInterface. # noqa: E501
- Return type
- property name¶
Gets the name of this RegionInterface. # noqa: E501
- Returns
The name of this RegionInterface. # noqa: E501
- Return type
str
- openapi_types = {'custom_modified': 'bool', 'interface_thermal': 'OneOfRegionInterfaceInterfaceThermal', 'is_partial': 'bool', 'master_topological_reference': 'TopologicalReference', 'name': 'str', 'slave_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property slave_topological_reference¶
Gets the slave_topological_reference of this RegionInterface. # noqa: E501
- Returns
The slave_topological_reference of this RegionInterface. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RegionInterface. # noqa: E501
Schema name: RegionInterface # noqa: E501
- Returns
The type of this RegionInterface. # noqa: E501
- Return type
str
simscale_sdk.models.region_of_interest module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_of_interest.RegionOfInterest(disc_radius=None, center_point=None, ground_height=None, north_angle=None, advanced_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_settings¶
Gets the advanced_settings of this RegionOfInterest. # noqa: E501
- Returns
The advanced_settings of this RegionOfInterest. # noqa: E501
- Return type
- attribute_map = {'advanced_settings': 'advancedSettings', 'center_point': 'centerPoint', 'disc_radius': 'discRadius', 'ground_height': 'groundHeight', 'north_angle': 'northAngle'}¶
- property center_point¶
Gets the center_point of this RegionOfInterest. # noqa: E501
- Returns
The center_point of this RegionOfInterest. # noqa: E501
- Return type
- property disc_radius¶
Gets the disc_radius of this RegionOfInterest. # noqa: E501
- Returns
The disc_radius of this RegionOfInterest. # noqa: E501
- Return type
- property ground_height¶
Gets the ground_height of this RegionOfInterest. # noqa: E501
- Returns
The ground_height of this RegionOfInterest. # noqa: E501
- Return type
- property north_angle¶
Gets the north_angle of this RegionOfInterest. # noqa: E501
- Returns
The north_angle of this RegionOfInterest. # noqa: E501
- Return type
- openapi_types = {'advanced_settings': 'AdvancedROISettings', 'center_point': 'DimensionalVector2dLength', 'disc_radius': 'DimensionalLength', 'ground_height': 'DimensionalLength', 'north_angle': 'DimensionalAngle'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.region_refinement_pacefish module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_refinement_pacefish.RegionRefinementPacefish(type='REGION_PACEFISH', name=None, target_resolution=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'target_resolution': 'targetResolution', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this RegionRefinementPacefish. # noqa: E501
- Returns
The geometry_primitive_uuids of this RegionRefinementPacefish. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this RegionRefinementPacefish. # noqa: E501
- Returns
The name of this RegionRefinementPacefish. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'target_resolution': 'DimensionalLength', 'type': 'str'}¶
- property target_resolution¶
Gets the target_resolution of this RegionRefinementPacefish. # noqa: E501
- Returns
The target_resolution of this RegionRefinementPacefish. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RegionRefinementPacefish. # noqa: E501
Schema name: RegionRefinementPacefish # noqa: E501
- Returns
The type of this RegionRefinementPacefish. # noqa: E501
- Return type
str
simscale_sdk.models.region_refinement_simerics module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_refinement_simerics.RegionRefinementSimerics(type='REGION_REFINEMENT_SIMERICS', name=None, refinement_cell_size=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'refinement_cell_size': 'refinementCellSize', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this RegionRefinementSimerics. # noqa: E501
- Returns
The geometry_primitive_uuids of this RegionRefinementSimerics. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this RegionRefinementSimerics. # noqa: E501
- Returns
The name of this RegionRefinementSimerics. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'refinement_cell_size': 'DimensionalLength', 'type': 'str'}¶
- property refinement_cell_size¶
Gets the refinement_cell_size of this RegionRefinementSimerics. # noqa: E501
- Returns
The refinement_cell_size of this RegionRefinementSimerics. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RegionRefinementSimerics. # noqa: E501
Schema name: RegionRefinementSimerics # noqa: E501
- Returns
The type of this RegionRefinementSimerics. # noqa: E501
- Return type
str
simscale_sdk.models.region_refinement_wind_comfort module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_refinement_wind_comfort.RegionRefinementWindComfort(type='REGION_REFINEMENT_WIND_COMFORT', name=None, new_fineness=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'new_fineness': 'newFineness', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this RegionRefinementWindComfort. # noqa: E501
- Returns
The geometry_primitive_uuids of this RegionRefinementWindComfort. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this RegionRefinementWindComfort. # noqa: E501
- Returns
The name of this RegionRefinementWindComfort. # noqa: E501
- Return type
str
- property new_fineness¶
Gets the new_fineness of this RegionRefinementWindComfort. # noqa: E501
- Returns
The new_fineness of this RegionRefinementWindComfort. # noqa: E501
- Return type
OneOfRegionRefinementWindComfortNewFineness
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'new_fineness': 'OneOfRegionRefinementWindComfortNewFineness', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RegionRefinementWindComfort. # noqa: E501
Schema name: RegionRefinementWindComfort # noqa: E501
- Returns
The type of this RegionRefinementWindComfort. # noqa: E501
- Return type
str
simscale_sdk.models.region_refinement_with_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_refinement_with_length.RegionRefinementWithLength(type='REGION_LENGTH', name=None, refinement=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'refinement': 'refinement', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this RegionRefinementWithLength. # noqa: E501
- Returns
The geometry_primitive_uuids of this RegionRefinementWithLength. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this RegionRefinementWithLength. # noqa: E501
- Returns
The name of this RegionRefinementWithLength. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'refinement': 'OneOfRegionRefinementWithLengthRefinement', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property refinement¶
Gets the refinement of this RegionRefinementWithLength. # noqa: E501
- Returns
The refinement of this RegionRefinementWithLength. # noqa: E501
- Return type
OneOfRegionRefinementWithLengthRefinement
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this RegionRefinementWithLength. # noqa: E501
- Returns
The topological_reference of this RegionRefinementWithLength. # noqa: E501
- Return type
- property type¶
Gets the type of this RegionRefinementWithLength. # noqa: E501
A <b>region refinement</b> can be used to refine the mesh in a given area. The refinement area needs to be defined either via an existing solid or a geometry primitive. Schema name: RegionRefinementWithLength # noqa: E501
- Returns
The type of this RegionRefinementWithLength. # noqa: E501
- Return type
str
simscale_sdk.models.region_refinement_with_levels module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.region_refinement_with_levels.RegionRefinementWithLevels(type='REGION_LEVELS', name=None, refinement=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'refinement': 'refinement', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this RegionRefinementWithLevels. # noqa: E501
- Returns
The geometry_primitive_uuids of this RegionRefinementWithLevels. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this RegionRefinementWithLevels. # noqa: E501
- Returns
The name of this RegionRefinementWithLevels. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'refinement': 'OneOfRegionRefinementWithLevelsRefinement', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property refinement¶
Gets the refinement of this RegionRefinementWithLevels. # noqa: E501
- Returns
The refinement of this RegionRefinementWithLevels. # noqa: E501
- Return type
OneOfRegionRefinementWithLevelsRefinement
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this RegionRefinementWithLevels. # noqa: E501
- Returns
The topological_reference of this RegionRefinementWithLevels. # noqa: E501
- Return type
- property type¶
Gets the type of this RegionRefinementWithLevels. # noqa: E501
A <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#region-refinement’ target=’_blank’><b>region refinement</b></a> can be used to refine the mesh in a given area. The refinement area needs to be defined either via a geometry primitive or an existing solid (Hex-dominant only). Schema name: RegionRefinementWithLevels # noqa: E501
- Returns
The type of this RegionRefinementWithLevels. # noqa: E501
- Return type
str
simscale_sdk.models.relative_convergence_criteria module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.relative_convergence_criteria.RelativeConvergenceCriteria(type='RELATIVE', tolerance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'tolerance': 'tolerance', 'type': 'type'}¶
- openapi_types = {'tolerance': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property tolerance¶
Gets the tolerance of this RelativeConvergenceCriteria. # noqa: E501
<p>Set the threshold value for convergence detection for the absolute convergence criteria. If the maximum abolute error of all DOFs fall below this value the current time step is considered convergent.</p> <br /><br />Important remarks: <br /><ul><li>In most of the cases using a lower value for tolerance may lead to hard or no convergence. Therefore, it is always recommended to start with a higher value e.g. 10<sup>-3</sup> or 10<sup>-4</sup>. Please also note that increasing the threshold value may effect the solution results. </li></ul> # noqa: E501
- Returns
The tolerance of this RelativeConvergenceCriteria. # noqa: E501
- Return type
float
- property type¶
Gets the type of this RelativeConvergenceCriteria. # noqa: E501
<p>Select the type of convergence criterion for the nonlinear solution method.</p> <br /><br />Important remarks: <br /><ul><li>Choose <b>absolute</b> if you want convergence to be reached when the maximum residual of all degrees of freedom of a given Newton iteration is lower than the given tolerance.</li><li>Choose <b>relative</b> if the same criteria as <b>absolute</b> will be checked but for the maximum relative residual i.e. maximum absolute residual divided by external force. Please note, if no external force is involved e.g. two far objects coming in contact, then using relative criteria will lead to singularity and convergence will not be attained.</li></ul> Schema name: RelativeConvergenceCriteria # noqa: E501
- Returns
The type of this RelativeConvergenceCriteria. # noqa: E501
- Return type
str
simscale_sdk.models.relaxation_factor module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.relaxation_factor.RelaxationFactor(pressure_field=None, pressure_rgh_field=None, passive_scalar_equation=None, velocity_equation=None, temperature_equation=None, density_field=None, enthalpy_equation=None, internal_energy_equation=None, turbulent_kinetic_energy_equation=None, omega_dissipation_rate_equation=None, epsilon_dissipation_rate_equation=None, nu_tilda_equation=None, net_radiative_heat_flux_field=None, radiative_intensity_ray_equation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'density_field': 'densityField', 'enthalpy_equation': 'enthalpyEquation', 'epsilon_dissipation_rate_equation': 'epsilonDissipationRateEquation', 'internal_energy_equation': 'internalEnergyEquation', 'net_radiative_heat_flux_field': 'netRadiativeHeatFluxField', 'nu_tilda_equation': 'nuTildaEquation', 'omega_dissipation_rate_equation': 'omegaDissipationRateEquation', 'passive_scalar_equation': 'passiveScalarEquation', 'pressure_field': 'pressureField', 'pressure_rgh_field': 'pressureRghField', 'radiative_intensity_ray_equation': 'radiativeIntensityRayEquation', 'temperature_equation': 'temperatureEquation', 'turbulent_kinetic_energy_equation': 'turbulentKineticEnergyEquation', 'velocity_equation': 'velocityEquation'}¶
- property density_field¶
Gets the density_field of this RelaxationFactor. # noqa: E501
<p>With this parameter you can initialize the under-relaxation of a field or equation. The solver will dynamically adapt this factor to improve stability.</p> # noqa: E501
- Returns
The density_field of this RelaxationFactor. # noqa: E501
- Return type
float
- property enthalpy_equation¶
Gets the enthalpy_equation of this RelaxationFactor. # noqa: E501
<p>With this parameter you can initialize the under-relaxation of a field or equation. The solver will dynamically adapt this factor to improve stability.</p> # noqa: E501
- Returns
The enthalpy_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property epsilon_dissipation_rate_equation¶
Gets the epsilon_dissipation_rate_equation of this RelaxationFactor. # noqa: E501
- Returns
The epsilon_dissipation_rate_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property internal_energy_equation¶
Gets the internal_energy_equation of this RelaxationFactor. # noqa: E501
<p>With this parameter you can initialize the under-relaxation of a field or equation. The solver will dynamically adapt this factor to improve stability.</p> # noqa: E501
- Returns
The internal_energy_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property net_radiative_heat_flux_field¶
Gets the net_radiative_heat_flux_field of this RelaxationFactor. # noqa: E501
- Returns
The net_radiative_heat_flux_field of this RelaxationFactor. # noqa: E501
- Return type
float
- property nu_tilda_equation¶
Gets the nu_tilda_equation of this RelaxationFactor. # noqa: E501
- Returns
The nu_tilda_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property omega_dissipation_rate_equation¶
Gets the omega_dissipation_rate_equation of this RelaxationFactor. # noqa: E501
- Returns
The omega_dissipation_rate_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- openapi_types = {'density_field': 'float', 'enthalpy_equation': 'float', 'epsilon_dissipation_rate_equation': 'float', 'internal_energy_equation': 'float', 'net_radiative_heat_flux_field': 'float', 'nu_tilda_equation': 'float', 'omega_dissipation_rate_equation': 'float', 'passive_scalar_equation': 'float', 'pressure_field': 'float', 'pressure_rgh_field': 'float', 'radiative_intensity_ray_equation': 'float', 'temperature_equation': 'float', 'turbulent_kinetic_energy_equation': 'float', 'velocity_equation': 'float'}¶
- property passive_scalar_equation¶
Gets the passive_scalar_equation of this RelaxationFactor. # noqa: E501
- Returns
The passive_scalar_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property pressure_field¶
Gets the pressure_field of this RelaxationFactor. # noqa: E501
<p>With this parameter you can initialize the under-relaxation of a field or equation. The solver will dynamically adapt this factor to improve stability.</p> # noqa: E501
- Returns
The pressure_field of this RelaxationFactor. # noqa: E501
- Return type
float
- property pressure_rgh_field¶
Gets the pressure_rgh_field of this RelaxationFactor. # noqa: E501
- Returns
The pressure_rgh_field of this RelaxationFactor. # noqa: E501
- Return type
float
- property radiative_intensity_ray_equation¶
Gets the radiative_intensity_ray_equation of this RelaxationFactor. # noqa: E501
- Returns
The radiative_intensity_ray_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property temperature_equation¶
Gets the temperature_equation of this RelaxationFactor. # noqa: E501
- Returns
The temperature_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulent_kinetic_energy_equation¶
Gets the turbulent_kinetic_energy_equation of this RelaxationFactor. # noqa: E501
- Returns
The turbulent_kinetic_energy_equation of this RelaxationFactor. # noqa: E501
- Return type
float
- property velocity_equation¶
Gets the velocity_equation of this RelaxationFactor. # noqa: E501
<p>With this parameter you can initialize the under-relaxation of a field or equation. The solver will dynamically adapt this factor to improve stability.</p> # noqa: E501
- Returns
The velocity_equation of this RelaxationFactor. # noqa: E501
- Return type
float
simscale_sdk.models.remote_displacement_load_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.remote_displacement_load_bc.RemoteDisplacementLoadBC(type='REMOTE_DISPLACEMENT_LOAD', name=None, displacement=None, rotation=None, external_point=None, deformation_behavior=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'deformation_behavior': 'deformationBehavior', 'displacement': 'displacement', 'external_point': 'externalPoint', 'name': 'name', 'rotation': 'rotation', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property deformation_behavior¶
Gets the deformation_behavior of this RemoteDisplacementLoadBC. # noqa: E501
<p>Choose the deformation behavior of the assigned entity. If <b>deformable</b> is selected, the entity is allowed to deform, selecting <b>undeformable</b> leads to a rigid entity.</p> # noqa: E501
- Returns
The deformation_behavior of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
str
- property displacement¶
Gets the displacement of this RemoteDisplacementLoadBC. # noqa: E501
- Returns
The displacement of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
- property external_point¶
Gets the external_point of this RemoteDisplacementLoadBC. # noqa: E501
- Returns
The external_point of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
- property name¶
Gets the name of this RemoteDisplacementLoadBC. # noqa: E501
- Returns
The name of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
str
- openapi_types = {'deformation_behavior': 'str', 'displacement': 'DimensionalPartialVectorFunctionLength', 'external_point': 'DimensionalVectorLength', 'name': 'str', 'rotation': 'DimensionalPartialVectorFunctionAngle', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property rotation¶
Gets the rotation of this RemoteDisplacementLoadBC. # noqa: E501
- Returns
The rotation of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this RemoteDisplacementLoadBC. # noqa: E501
- Returns
The topological_reference of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this RemoteDisplacementLoadBC. # noqa: E501
This boundary condition restrains the displacement of a face or edge relative to a specified remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined constraints are applied to the remote point.<br /><br />Important remarks: <br /><ul><li>As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.</li><li>If the number of nodes of the assigment is large (>1000), it is recommended to use the <b>MUMPS</b> or <b>PETSC</b> solver.</li><li>This boundary condition is only valid for small rotations. For large rotations, please use <b>Rotating motion</b> boundary conditions.</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/remote-displacement/’ target=’_blank’>Learn more</a>. Schema name: RemoteDisplacementLoadBC # noqa: E501
- Returns
The type of this RemoteDisplacementLoadBC. # noqa: E501
- Return type
str
simscale_sdk.models.remote_force_load_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.remote_force_load_bc.RemoteForceLoadBC(type='REMOTE_FORCE_LOAD', name=None, force=None, moment=None, scaling=None, phase_angle=None, remote_point=None, deformation_behavior=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'deformation_behavior': 'deformationBehavior', 'force': 'force', 'moment': 'moment', 'name': 'name', 'phase_angle': 'phaseAngle', 'remote_point': 'remotePoint', 'scaling': 'scaling', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property deformation_behavior¶
Gets the deformation_behavior of this RemoteForceLoadBC. # noqa: E501
<p>Choose the deformation behavior of the assigned entity. If <b>deformable</b> is selected, the entitiy is allowed to deform without applying additional stiffness, selecting <b>undeformable</b> leads to a rigid entity.</p> # noqa: E501
- Returns
The deformation_behavior of this RemoteForceLoadBC. # noqa: E501
- Return type
str
- property force¶
Gets the force of this RemoteForceLoadBC. # noqa: E501
- Returns
The force of this RemoteForceLoadBC. # noqa: E501
- Return type
- property moment¶
Gets the moment of this RemoteForceLoadBC. # noqa: E501
- Returns
The moment of this RemoteForceLoadBC. # noqa: E501
- Return type
- property name¶
Gets the name of this RemoteForceLoadBC. # noqa: E501
- Returns
The name of this RemoteForceLoadBC. # noqa: E501
- Return type
str
- openapi_types = {'deformation_behavior': 'str', 'force': 'DimensionalVectorFunctionForce', 'moment': 'DimensionalVectorFunctionTorque', 'name': 'str', 'phase_angle': 'DimensionalAngle', 'remote_point': 'DimensionalVectorLength', 'scaling': 'DimensionalFunctionDimensionless', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this RemoteForceLoadBC. # noqa: E501
- Returns
The phase_angle of this RemoteForceLoadBC. # noqa: E501
- Return type
- property remote_point¶
Gets the remote_point of this RemoteForceLoadBC. # noqa: E501
- Returns
The remote_point of this RemoteForceLoadBC. # noqa: E501
- Return type
- property scaling¶
Gets the scaling of this RemoteForceLoadBC. # noqa: E501
- Returns
The scaling of this RemoteForceLoadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this RemoteForceLoadBC. # noqa: E501
- Returns
The topological_reference of this RemoteForceLoadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this RemoteForceLoadBC. # noqa: E501
This is a <b>remote force</b> boundary condition where the load is applied on the assignment via a remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined force is applied to the remote point.<br /><br />Important remarks: <br /><ul><li>The total force will be <b>distributed on the selection</b>.</li><li>As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.</li><li>If the number of nodes of the assignment is large (>1000), it is recommended to use the <b>MUMPS</b> or <b>PETSC</b> solver.</li><li>This boundary condition is only valid for small rotations. </li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/remote-force/’ target=’_blank’>Learn more</a>. Schema name: RemoteForceLoadBC # noqa: E501
- Returns
The type of this RemoteForceLoadBC. # noqa: E501
- Return type
str
simscale_sdk.models.render_mode module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.render_mode.RenderMode(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- MESH = 'MESH'¶
- SURFACES = 'SURFACES'¶
- SURFACES_WITH_MESH = 'SURFACES_WITH_MESH'¶
- SURFACES_WITH_WIREFRAME = 'SURFACES_WITH_WIREFRAME'¶
- WIREFRAME = 'WIREFRAME'¶
- allowable_values = ['SURFACES_WITH_WIREFRAME', 'WIREFRAME', 'SURFACES', 'SURFACES_WITH_MESH', 'MESH']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.report_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.report_request.ReportRequest(name=None, description=None, result_ids=None, report_properties=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'description': 'description', 'name': 'name', 'report_properties': 'reportProperties', 'result_ids': 'resultIds'}¶
- property description¶
Gets the description of this ReportRequest. # noqa: E501
The description of the report. # noqa: E501
- Returns
The description of this ReportRequest. # noqa: E501
- Return type
str
- property name¶
Gets the name of this ReportRequest. # noqa: E501
The name of the report. # noqa: E501
- Returns
The name of this ReportRequest. # noqa: E501
- Return type
str
- openapi_types = {'description': 'str', 'name': 'str', 'report_properties': 'OneOfReportProperties', 'result_ids': 'list[str]'}¶
- property report_properties¶
Gets the report_properties of this ReportRequest. # noqa: E501
- Returns
The report_properties of this ReportRequest. # noqa: E501
- Return type
OneOfReportProperties
- property result_ids¶
Gets the result_ids of this ReportRequest. # noqa: E501
The resultIds the report should be created for. # noqa: E501
- Returns
The result_ids of this ReportRequest. # noqa: E501
- Return type
list[str]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.report_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.report_response.ReportResponse(report_id=None, name=None, description=None, created_at=None, started_at=None, finished_at=None, status=None, result_ids=None, report_properties=None, download=None, failure_reason=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'description': 'description', 'download': 'download', 'failure_reason': 'failureReason', 'finished_at': 'finishedAt', 'name': 'name', 'report_id': 'reportId', 'report_properties': 'reportProperties', 'result_ids': 'resultIds', 'started_at': 'startedAt', 'status': 'status'}¶
- property created_at¶
Gets the created_at of this ReportResponse. # noqa: E501
The time the report was created. # noqa: E501
- Returns
The created_at of this ReportResponse. # noqa: E501
- Return type
datetime
- property description¶
Gets the description of this ReportResponse. # noqa: E501
The description of the report. # noqa: E501
- Returns
The description of this ReportResponse. # noqa: E501
- Return type
str
- property download¶
Gets the download of this ReportResponse. # noqa: E501
- Returns
The download of this ReportResponse. # noqa: E501
- Return type
- property failure_reason¶
Gets the failure_reason of this ReportResponse. # noqa: E501
- Returns
The failure_reason of this ReportResponse. # noqa: E501
- Return type
- property finished_at¶
Gets the finished_at of this ReportResponse. # noqa: E501
The time the report was finished. # noqa: E501
- Returns
The finished_at of this ReportResponse. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this ReportResponse. # noqa: E501
The name of the report. # noqa: E501
- Returns
The name of this ReportResponse. # noqa: E501
- Return type
str
- openapi_types = {'created_at': 'datetime', 'description': 'str', 'download': 'DownloadInfo', 'failure_reason': 'ReportResponseFailureReason', 'finished_at': 'datetime', 'name': 'str', 'report_id': 'str', 'report_properties': 'OneOfReportProperties', 'result_ids': 'list[str]', 'started_at': 'datetime', 'status': 'str'}¶
- property report_id¶
Gets the report_id of this ReportResponse. # noqa: E501
The ID of the report. # noqa: E501
- Returns
The report_id of this ReportResponse. # noqa: E501
- Return type
str
- property report_properties¶
Gets the report_properties of this ReportResponse. # noqa: E501
- Returns
The report_properties of this ReportResponse. # noqa: E501
- Return type
OneOfReportProperties
- property result_ids¶
Gets the result_ids of this ReportResponse. # noqa: E501
The resultIds the report has been created for. # noqa: E501
- Returns
The result_ids of this ReportResponse. # noqa: E501
- Return type
list[str]
- property started_at¶
Gets the started_at of this ReportResponse. # noqa: E501
The time the report was started. # noqa: E501
- Returns
The started_at of this ReportResponse. # noqa: E501
- Return type
datetime
- property status¶
Gets the status of this ReportResponse. # noqa: E501
Status of the report operation. # noqa: E501
- Returns
The status of this ReportResponse. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.report_response_failure_reason module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.report_response_failure_reason.ReportResponseFailureReason(severity=None, code=None, message=None, details=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'code': 'code', 'details': 'details', 'message': 'message', 'severity': 'severity'}¶
- property code¶
Gets the code of this ReportResponseFailureReason. # noqa: E501
Code for e.g. programmatic handling of error conditions. # noqa: E501
- Returns
The code of this ReportResponseFailureReason. # noqa: E501
- Return type
str
- property details¶
Gets the details of this ReportResponseFailureReason. # noqa: E501
Additional data to interpret and handle the entry. # noqa: E501
- Returns
The details of this ReportResponseFailureReason. # noqa: E501
- Return type
dict(str, object)
- property message¶
Gets the message of this ReportResponseFailureReason. # noqa: E501
Human-readable description of the entry. # noqa: E501
- Returns
The message of this ReportResponseFailureReason. # noqa: E501
- Return type
str
- openapi_types = {'code': 'str', 'details': 'dict(str, object)', 'message': 'str', 'severity': 'str'}¶
- property severity¶
Gets the severity of this ReportResponseFailureReason. # noqa: E501
- Returns
The severity of this ReportResponseFailureReason. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.report_responses module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.report_responses.ReportResponses(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this ReportResponses. # noqa: E501
- Returns
The embedded of this ReportResponses. # noqa: E501
- Return type
list[ReportResponse]
- property links¶
Gets the links of this ReportResponses. # noqa: E501
- Returns
The links of this ReportResponses. # noqa: E501
- Return type
- property meta¶
Gets the meta of this ReportResponses. # noqa: E501
- Returns
The meta of this ReportResponses. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[ReportResponse]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.residual_controls module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.residual_controls.ResidualControls(velocity=None, pressure=None, pressure_rgh=None, temperature=None, turbulent_kinetic_energy=None, omega_dissipation_rate=None, epsilon_dissipation_rate=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'epsilon_dissipation_rate': 'epsilonDissipationRate', 'omega_dissipation_rate': 'omegaDissipationRate', 'pressure': 'pressure', 'pressure_rgh': 'pressureRgh', 'temperature': 'temperature', 'turbulent_kinetic_energy': 'turbulentKineticEnergy', 'velocity': 'velocity'}¶
- property epsilon_dissipation_rate¶
Gets the epsilon_dissipation_rate of this ResidualControls. # noqa: E501
- Returns
The epsilon_dissipation_rate of this ResidualControls. # noqa: E501
- Return type
- property omega_dissipation_rate¶
Gets the omega_dissipation_rate of this ResidualControls. # noqa: E501
- Returns
The omega_dissipation_rate of this ResidualControls. # noqa: E501
- Return type
- openapi_types = {'epsilon_dissipation_rate': 'Tolerance', 'omega_dissipation_rate': 'Tolerance', 'pressure': 'Tolerance', 'pressure_rgh': 'Tolerance', 'temperature': 'Tolerance', 'turbulent_kinetic_energy': 'Tolerance', 'velocity': 'Tolerance'}¶
- property pressure¶
Gets the pressure of this ResidualControls. # noqa: E501
- Returns
The pressure of this ResidualControls. # noqa: E501
- Return type
- property pressure_rgh¶
Gets the pressure_rgh of this ResidualControls. # noqa: E501
- Returns
The pressure_rgh of this ResidualControls. # noqa: E501
- Return type
- property temperature¶
Gets the temperature of this ResidualControls. # noqa: E501
- Returns
The temperature of this ResidualControls. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulent_kinetic_energy¶
Gets the turbulent_kinetic_energy of this ResidualControls. # noqa: E501
- Returns
The turbulent_kinetic_energy of this ResidualControls. # noqa: E501
- Return type
simscale_sdk.models.resolution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.resolution.Resolution(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'x': 'int', 'y': 'int', 'z': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this Resolution. # noqa: E501
<p>Specify the number of cells in x direction for the <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/main-settings-for-hex-dominant-parametric/#main-properties’ target=’_blank’>base mesh</a>.</p> # noqa: E501
- Returns
The x of this Resolution. # noqa: E501
- Return type
int
- property y¶
Gets the y of this Resolution. # noqa: E501
<p>Specify the number of cells in y direction for the <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/main-settings-for-hex-dominant-parametric/#main-properties’ target=’_blank’>base mesh</a>.</p> # noqa: E501
- Returns
The y of this Resolution. # noqa: E501
- Return type
int
- property z¶
Gets the z of this Resolution. # noqa: E501
<p><p>Specify the number of cells in z direction for the <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/main-settings-for-hex-dominant-parametric/#main-properties’ target=’_blank’>base mesh</a>.</p> # noqa: E501
- Returns
The z of this Resolution. # noqa: E501
- Return type
int
simscale_sdk.models.resolution_info module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.resolution_info.ResolutionInfo(x=None, y=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y'}¶
- openapi_types = {'x': 'int', 'y': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this ResolutionInfo. # noqa: E501
- Returns
The x of this ResolutionInfo. # noqa: E501
- Return type
int
- property y¶
Gets the y of this ResolutionInfo. # noqa: E501
- Returns
The y of this ResolutionInfo. # noqa: E501
- Return type
int
simscale_sdk.models.restricted_dimensional_function_frequency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.restricted_dimensional_function_frequency.RestrictedDimensionalFunctionFrequency(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfRestrictedDimensionalFunctionFrequencyValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this RestrictedDimensionalFunctionFrequency. # noqa: E501
- Returns
The unit of this RestrictedDimensionalFunctionFrequency. # noqa: E501
- Return type
str
- property value¶
Gets the value of this RestrictedDimensionalFunctionFrequency. # noqa: E501
- Returns
The value of this RestrictedDimensionalFunctionFrequency. # noqa: E501
- Return type
OneOfRestrictedDimensionalFunctionFrequencyValue
simscale_sdk.models.restricted_dimensional_function_time module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.restricted_dimensional_function_time.RestrictedDimensionalFunctionTime(value=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit', 'value': 'value'}¶
- openapi_types = {'unit': 'str', 'value': 'OneOfRestrictedDimensionalFunctionTimeValue'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this RestrictedDimensionalFunctionTime. # noqa: E501
- Returns
The unit of this RestrictedDimensionalFunctionTime. # noqa: E501
- Return type
str
- property value¶
Gets the value of this RestrictedDimensionalFunctionTime. # noqa: E501
- Returns
The value of this RestrictedDimensionalFunctionTime. # noqa: E501
- Return type
OneOfRestrictedDimensionalFunctionTimeValue
simscale_sdk.models.restricted_table_defined_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.restricted_table_defined_function.RestrictedTableDefinedFunction(type='RESTRICTED_TABLE_DEFINED', label=None, table_id=None, result_index=None, independent_variables=None, separator=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'independent_variables': 'independentVariables', 'label': 'label', 'result_index': 'resultIndex', 'separator': 'separator', 'table_id': 'tableId', 'type': 'type'}¶
- property independent_variables¶
Gets the independent_variables of this RestrictedTableDefinedFunction. # noqa: E501
- Returns
The independent_variables of this RestrictedTableDefinedFunction. # noqa: E501
- Return type
list[TableFunctionParameter]
- property label¶
Gets the label of this RestrictedTableDefinedFunction. # noqa: E501
- Returns
The label of this RestrictedTableDefinedFunction. # noqa: E501
- Return type
str
- openapi_types = {'independent_variables': 'list[TableFunctionParameter]', 'label': 'str', 'result_index': 'list[int]', 'separator': 'str', 'table_id': 'str', 'type': 'str'}¶
- property result_index¶
Gets the result_index of this RestrictedTableDefinedFunction. # noqa: E501
Indicates which column(s) of the table contains the result values. One-based indexing must be used. For example, set this field to ‘[2]’ if the second column of the table contains the dependent variable values. # noqa: E501
- Returns
The result_index of this RestrictedTableDefinedFunction. # noqa: E501
- Return type
list[int]
- property separator¶
Gets the separator of this RestrictedTableDefinedFunction. # noqa: E501
Values in each row are separated by this character. Also known as a delimiter. # noqa: E501
- Returns
The separator of this RestrictedTableDefinedFunction. # noqa: E501
- Return type
str
- property table_id¶
Gets the table_id of this RestrictedTableDefinedFunction. # noqa: E501
The ID of the imported table. # noqa: E501
- Returns
The table_id of this RestrictedTableDefinedFunction. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RestrictedTableDefinedFunction. # noqa: E501
Schema name: RestrictedTableDefinedFunction # noqa: E501
- Returns
The type of this RestrictedTableDefinedFunction. # noqa: E501
- Return type
str
simscale_sdk.models.reynolds_stress_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.reynolds_stress_result_type.ReynoldsStressResultType(type='REYNOLDS_STRESS_TENSOR', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ReynoldsStressResultType. # noqa: E501
Schema name: ReynoldsStressResultType # noqa: E501
- Returns
The type of this ReynoldsStressResultType. # noqa: E501
- Return type
str
simscale_sdk.models.rho_const_equation_of_state module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rho_const_equation_of_state.RhoConstEquationOfState(type='RHO_CONST', density=None, energy=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'density': 'density', 'energy': 'energy', 'type': 'type'}¶
- property density¶
Gets the density of this RhoConstEquationOfState. # noqa: E501
- Returns
The density of this RhoConstEquationOfState. # noqa: E501
- Return type
- property energy¶
Gets the energy of this RhoConstEquationOfState. # noqa: E501
<p><b>Energy</b> provides the methods for the form of energy to be used. The options are:</p><p><b>Sensible enthalpy:</b> The enthalpy form of equation is used without the heat of formation. In most cases this is the recommended choice.</p><p><b>Sensible internal Energy:</b> The internal energy form of equation is used without the heat of formation but also incorporates energy change due to reactions.</p> # noqa: E501
- Returns
The energy of this RhoConstEquationOfState. # noqa: E501
- Return type
str
- openapi_types = {'density': 'DimensionalDensity', 'energy': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RhoConstEquationOfState. # noqa: E501
<br><p>The <b>Equation of state</b> describes the relation between density of a fluid and the fluid pressure and temperature. The available options are:</p><p><b>Rho const:</b> Fluid density is assumed constant.</p><p><b>Incompressibel perfect gas:</b> The fluid is assumed to be an ‘Ideal Gas’ that is incompressible by pressure. But, fluid density can change due to temperature.</p><p><b>Perfect gas:</b> Fluid is assumed to be an ‘Ideal Gas’ and obeys the ‘Ideal Gas Law’.</p><p><b>Perfect fluid:</b> Fluid density can change due to pressure and temperature with respect to a base value.</p><p><b>Adiabatic perfect fluid:</b> The fluid is a perfect fluid which is adiabatic in nature.</p> <a href=’https://www.simscale.com/docs/simulation-setup/materials/thermophysical-fluid-models/#equation-of-state’ target=’_blank’>Learn more</a>. Schema name: RhoConstEquationOfState # noqa: E501
- Returns
The type of this RhoConstEquationOfState. # noqa: E501
- Return type
str
simscale_sdk.models.rotatable_cartesian_box module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rotatable_cartesian_box.RotatableCartesianBox(type='ROTATABLE_CARTESIAN_BOX', id=None, name=None, min=None, max=None, rotation_point=None, rotation_angles=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'max': 'max', 'min': 'min', 'name': 'name', 'rotation_angles': 'rotationAngles', 'rotation_point': 'rotationPoint', 'type': 'type'}¶
- property id¶
Gets the id of this RotatableCartesianBox. # noqa: E501
- Returns
The id of this RotatableCartesianBox. # noqa: E501
- Return type
str
- property max¶
Gets the max of this RotatableCartesianBox. # noqa: E501
- Returns
The max of this RotatableCartesianBox. # noqa: E501
- Return type
- property min¶
Gets the min of this RotatableCartesianBox. # noqa: E501
- Returns
The min of this RotatableCartesianBox. # noqa: E501
- Return type
- property name¶
Gets the name of this RotatableCartesianBox. # noqa: E501
- Returns
The name of this RotatableCartesianBox. # noqa: E501
- Return type
str
- openapi_types = {'id': 'str', 'max': 'DimensionalVectorLength', 'min': 'DimensionalVectorLength', 'name': 'str', 'rotation_angles': 'DimensionalVectorAngle', 'rotation_point': 'DimensionalVectorLength', 'type': 'str'}¶
- property rotation_angles¶
Gets the rotation_angles of this RotatableCartesianBox. # noqa: E501
- Returns
The rotation_angles of this RotatableCartesianBox. # noqa: E501
- Return type
- property rotation_point¶
Gets the rotation_point of this RotatableCartesianBox. # noqa: E501
- Returns
The rotation_point of this RotatableCartesianBox. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RotatableCartesianBox. # noqa: E501
Schema name: RotatableCartesianBox # noqa: E501
- Returns
The type of this RotatableCartesianBox. # noqa: E501
- Return type
str
simscale_sdk.models.rotating_motion_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rotating_motion_bc.RotatingMotionBC(type='ROTATING_MOTION', name=None, rotation_origin=None, rotation_axis=None, omega=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'omega': 'omega', 'rotation_axis': 'rotationAxis', 'rotation_origin': 'rotationOrigin', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this RotatingMotionBC. # noqa: E501
- Returns
The name of this RotatingMotionBC. # noqa: E501
- Return type
str
- property omega¶
Gets the omega of this RotatingMotionBC. # noqa: E501
- Returns
The omega of this RotatingMotionBC. # noqa: E501
- Return type
- openapi_types = {'name': 'str', 'omega': 'DimensionalFunctionAngle', 'rotation_axis': 'DimensionalVectorFunctionLength', 'rotation_origin': 'DimensionalVectorFunctionLength', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property rotation_axis¶
Gets the rotation_axis of this RotatingMotionBC. # noqa: E501
- Returns
The rotation_axis of this RotatingMotionBC. # noqa: E501
- Return type
- property rotation_origin¶
Gets the rotation_origin of this RotatingMotionBC. # noqa: E501
- Returns
The rotation_origin of this RotatingMotionBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this RotatingMotionBC. # noqa: E501
- Returns
The topological_reference of this RotatingMotionBC. # noqa: E501
- Return type
- property type¶
Gets the type of this RotatingMotionBC. # noqa: E501
<p>The <b>rotating motion</b> constraint applies a predefined rigid body rotation to the assigned entities. The rotation axis, the base point, and the rotation angle needs to be specified. Each component can be defined with a formula or table input.<br /><br />Important remarks: <br /><ul><li>If a component of the rotation axis is input via formula or table, then ensure that the length of the axis vector is always positive.</li><li>If a continuous, transient rotation is required, then the rotation angle has to be given either as a formula or table value.</li></ul></p><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/rotating-motion/’ target=’_blank’>Learn more</a>. Schema name: RotatingMotionBC # noqa: E501
- Returns
The type of this RotatingMotionBC. # noqa: E501
- Return type
str
simscale_sdk.models.rotating_motion_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rotating_motion_type.RotatingMotionType(type='ROTATING_MOTION', rotation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'rotation': 'rotation', 'type': 'type'}¶
- openapi_types = {'rotation': 'OneOfRotatingMotionTypeRotation', 'type': 'str'}¶
- property rotation¶
Gets the rotation of this RotatingMotionType. # noqa: E501
- Returns
The rotation of this RotatingMotionType. # noqa: E501
- Return type
OneOfRotatingMotionTypeRotation
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RotatingMotionType. # noqa: E501
Schema name: RotatingMotionType # noqa: E501
- Returns
The type of this RotatingMotionType. # noqa: E501
- Return type
str
simscale_sdk.models.rotating_sbm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rotating_sbm.RotatingSBM(type='ROTATING_MOTION', name=None, rotation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'rotation': 'rotation', 'type': 'type'}¶
- property name¶
Gets the name of this RotatingSBM. # noqa: E501
- Returns
The name of this RotatingSBM. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'rotation': 'OneOfRotatingSBMRotation', 'type': 'str'}¶
- property rotation¶
Gets the rotation of this RotatingSBM. # noqa: E501
- Returns
The rotation of this RotatingSBM. # noqa: E501
- Return type
OneOfRotatingSBMRotation
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RotatingSBM. # noqa: E501
Schema name: RotatingSBM # noqa: E501
- Returns
The type of this RotatingSBM. # noqa: E501
- Return type
str
simscale_sdk.models.rotating_wall module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rotating_wall.RotatingWall(name=None, origin=None, axis=None, rotational_velocity=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'axis': 'axis', 'name': 'name', 'origin': 'origin', 'rotational_velocity': 'rotationalVelocity', 'topological_reference': 'topologicalReference'}¶
- property axis¶
Gets the axis of this RotatingWall. # noqa: E501
- Returns
The axis of this RotatingWall. # noqa: E501
- Return type
- property name¶
Gets the name of this RotatingWall. # noqa: E501
- Returns
The name of this RotatingWall. # noqa: E501
- Return type
str
- openapi_types = {'axis': 'DimensionalVectorLength', 'name': 'str', 'origin': 'DimensionalVectorLength', 'rotational_velocity': 'DimensionalRotationSpeed', 'topological_reference': 'TopologicalReference'}¶
- property origin¶
Gets the origin of this RotatingWall. # noqa: E501
- Returns
The origin of this RotatingWall. # noqa: E501
- Return type
- property rotational_velocity¶
Gets the rotational_velocity of this RotatingWall. # noqa: E501
- Returns
The rotational_velocity of this RotatingWall. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this RotatingWall. # noqa: E501
- Returns
The topological_reference of this RotatingWall. # noqa: E501
- Return type
simscale_sdk.models.rotating_wall_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.rotating_wall_vbc.RotatingWallVBC(type='ROTATING_WALL_VELOCITY', rotation=None, turbulence_wall=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'rotation': 'rotation', 'turbulence_wall': 'turbulenceWall', 'type': 'type'}¶
- openapi_types = {'rotation': 'AngularRotation', 'turbulence_wall': 'str', 'type': 'str'}¶
- property rotation¶
Gets the rotation of this RotatingWallVBC. # noqa: E501
- Returns
The rotation of this RotatingWallVBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_wall¶
Gets the turbulence_wall of this RotatingWallVBC. # noqa: E501
- Returns
The turbulence_wall of this RotatingWallVBC. # noqa: E501
- Return type
str
- property type¶
Gets the type of this RotatingWallVBC. # noqa: E501
Schema name: RotatingWallVBC # noqa: E501
- Returns
The type of this RotatingWallVBC. # noqa: E501
- Return type
str
simscale_sdk.models.run_time_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.run_time_write_control.RunTimeWriteControl(type='RUNTIME', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'DimensionalTime'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this RunTimeWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: RunTimeWriteControl # noqa: E501
- Returns
The type of this RunTimeWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this RunTimeWriteControl. # noqa: E501
- Returns
The write_interval of this RunTimeWriteControl. # noqa: E501
- Return type
simscale_sdk.models.scalar_field module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.scalar_field.ScalarField(field_name=None, component=None, data_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component': 'component', 'data_type': 'dataType', 'field_name': 'fieldName'}¶
- property component¶
Gets the component of this ScalarField. # noqa: E501
- Returns
The component of this ScalarField. # noqa: E501
- Return type
str
- property data_type¶
Gets the data_type of this ScalarField. # noqa: E501
- Returns
The data_type of this ScalarField. # noqa: E501
- Return type
- property field_name¶
Gets the field_name of this ScalarField. # noqa: E501
- Returns
The field_name of this ScalarField. # noqa: E501
- Return type
str
- openapi_types = {'component': 'str', 'data_type': 'DataType', 'field_name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.scalar_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.scalar_settings.ScalarSettings(scalar_field=None, minimum_range=None, maximum_range=None, node_average_value=None, number_of_divisions=None, color_scheme=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'color_scheme': 'colorScheme', 'maximum_range': 'maximumRange', 'minimum_range': 'minimumRange', 'node_average_value': 'nodeAverageValue', 'number_of_divisions': 'numberOfDivisions', 'scalar_field': 'scalarField'}¶
- property color_scheme¶
Gets the color_scheme of this ScalarSettings. # noqa: E501
The color scheme to use to map scalar values on the model and legend bar. # noqa: E501
- Returns
The color_scheme of this ScalarSettings. # noqa: E501
- Return type
str
- property maximum_range¶
Gets the maximum_range of this ScalarSettings. # noqa: E501
The maximum value for the color scheme to fill. Default is the maximum value of the scalar. # noqa: E501
- Returns
The maximum_range of this ScalarSettings. # noqa: E501
- Return type
float
- property minimum_range¶
Gets the minimum_range of this ScalarSettings. # noqa: E501
The minimum value for the color scheme to fill. Default is the minimum value of the scalar. # noqa: E501
- Returns
The minimum_range of this ScalarSettings. # noqa: E501
- Return type
float
- property node_average_value¶
Gets the node_average_value of this ScalarSettings. # noqa: E501
Specify if the scalar result should be shown as a node averaged result or not. # noqa: E501
- Returns
The node_average_value of this ScalarSettings. # noqa: E501
- Return type
bool
- property number_of_divisions¶
Gets the number_of_divisions of this ScalarSettings. # noqa: E501
The number of divisions in the legend. If set to 0, this will create a continuous (gradient) legend with a smooth interpolation between the colors. # noqa: E501
- Returns
The number_of_divisions of this ScalarSettings. # noqa: E501
- Return type
int
- openapi_types = {'color_scheme': 'str', 'maximum_range': 'float', 'minimum_range': 'float', 'node_average_value': 'bool', 'number_of_divisions': 'int', 'scalar_field': 'ScalarField'}¶
- property scalar_field¶
Gets the scalar_field of this ScalarSettings. # noqa: E501
- Returns
The scalar_field of this ScalarSettings. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.scalar_transport_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.scalar_transport_result_control.ScalarTransportResultControl(name=None, diffusion_coefficient=None, volume_mode=None, su=None, sp=None, write_control=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'diffusion_coefficient': 'diffusionCoefficient', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'sp': 'sp', 'su': 'su', 'volume_mode': 'volumeMode', 'write_control': 'writeControl'}¶
- property diffusion_coefficient¶
Gets the diffusion_coefficient of this ScalarTransportResultControl. # noqa: E501
- Returns
The diffusion_coefficient of this ScalarTransportResultControl. # noqa: E501
- Return type
float
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this ScalarTransportResultControl. # noqa: E501
- Returns
The geometry_primitive_uuids of this ScalarTransportResultControl. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this ScalarTransportResultControl. # noqa: E501
- Returns
The name of this ScalarTransportResultControl. # noqa: E501
- Return type
str
- openapi_types = {'diffusion_coefficient': 'float', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'sp': 'float', 'su': 'float', 'volume_mode': 'str', 'write_control': 'OneOfScalarTransportResultControlWriteControl'}¶
- property sp¶
Gets the sp of this ScalarTransportResultControl. # noqa: E501
- Returns
The sp of this ScalarTransportResultControl. # noqa: E501
- Return type
float
- property su¶
Gets the su of this ScalarTransportResultControl. # noqa: E501
- Returns
The su of this ScalarTransportResultControl. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property volume_mode¶
Gets the volume_mode of this ScalarTransportResultControl. # noqa: E501
- Returns
The volume_mode of this ScalarTransportResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this ScalarTransportResultControl. # noqa: E501
- Returns
The write_control of this ScalarTransportResultControl. # noqa: E501
- Return type
OneOfScalarTransportResultControlWriteControl
simscale_sdk.models.schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.schemes.Schemes(flux=None, time_differentiation=None, gradient=None, divergence=None, laplacian=None, interpolation=None, surface_normal_gradient=None, second_order_convection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'divergence': 'divergence', 'flux': 'flux', 'gradient': 'gradient', 'interpolation': 'interpolation', 'laplacian': 'laplacian', 'second_order_convection': 'secondOrderConvection', 'surface_normal_gradient': 'surfaceNormalGradient', 'time_differentiation': 'timeDifferentiation'}¶
- property divergence¶
Gets the divergence of this Schemes. # noqa: E501
- Returns
The divergence of this Schemes. # noqa: E501
- Return type
- property flux¶
Gets the flux of this Schemes. # noqa: E501
- Returns
The flux of this Schemes. # noqa: E501
- Return type
- property gradient¶
Gets the gradient of this Schemes. # noqa: E501
- Returns
The gradient of this Schemes. # noqa: E501
- Return type
- property interpolation¶
Gets the interpolation of this Schemes. # noqa: E501
- Returns
The interpolation of this Schemes. # noqa: E501
- Return type
- property laplacian¶
Gets the laplacian of this Schemes. # noqa: E501
- Returns
The laplacian of this Schemes. # noqa: E501
- Return type
- openapi_types = {'divergence': 'DivergenceSchemes', 'flux': 'FluxSchemes', 'gradient': 'GradientSchemes', 'interpolation': 'InterpolationSchemes', 'laplacian': 'LaplacianSchemes', 'second_order_convection': 'bool', 'surface_normal_gradient': 'SurfaceNormalGradientSchemes', 'time_differentiation': 'TimeDifferentiationSchemes'}¶
- property second_order_convection¶
Gets the second_order_convection of this Schemes. # noqa: E501
Whether to use second-order convection scheme, which is less stable but more accurate for a given mesh. If false, first-order accurate upwind scheme is used. # noqa: E501
- Returns
The second_order_convection of this Schemes. # noqa: E501
- Return type
bool
- property surface_normal_gradient¶
Gets the surface_normal_gradient of this Schemes. # noqa: E501
- Returns
The surface_normal_gradient of this Schemes. # noqa: E501
- Return type
- property time_differentiation¶
Gets the time_differentiation of this Schemes. # noqa: E501
- Returns
The time_differentiation of this Schemes. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.scotch_decompose_algorithm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.scotch_decompose_algorithm.ScotchDecomposeAlgorithm(type='SCOTCH', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ScotchDecomposeAlgorithm. # noqa: E501
Schema name: ScotchDecomposeAlgorithm # noqa: E501
- Returns
The type of this ScotchDecomposeAlgorithm. # noqa: E501
- Return type
str
simscale_sdk.models.screenshot_output_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.screenshot_output_settings.ScreenshotOutputSettings(name=None, format='PNG', resolution=None, frame_index=None, show_legend=True, show_cube=True, background_color=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'background_color': 'backgroundColor', 'format': 'format', 'frame_index': 'frameIndex', 'name': 'name', 'resolution': 'resolution', 'show_cube': 'showCube', 'show_legend': 'showLegend'}¶
- property background_color¶
Gets the background_color of this ScreenshotOutputSettings. # noqa: E501
- Returns
The background_color of this ScreenshotOutputSettings. # noqa: E501
- Return type
- property format¶
Gets the format of this ScreenshotOutputSettings. # noqa: E501
- Returns
The format of this ScreenshotOutputSettings. # noqa: E501
- Return type
str
- property frame_index¶
Gets the frame_index of this ScreenshotOutputSettings. # noqa: E501
Default to the last timestep or frame in the result. # noqa: E501
- Returns
The frame_index of this ScreenshotOutputSettings. # noqa: E501
- Return type
int
- property name¶
Gets the name of this ScreenshotOutputSettings. # noqa: E501
- Returns
The name of this ScreenshotOutputSettings. # noqa: E501
- Return type
str
- openapi_types = {'background_color': 'Color', 'format': 'str', 'frame_index': 'int', 'name': 'str', 'resolution': 'ResolutionInfo', 'show_cube': 'bool', 'show_legend': 'bool'}¶
- property resolution¶
Gets the resolution of this ScreenshotOutputSettings. # noqa: E501
- Returns
The resolution of this ScreenshotOutputSettings. # noqa: E501
- Return type
- property show_cube¶
Gets the show_cube of this ScreenshotOutputSettings. # noqa: E501
- Returns
The show_cube of this ScreenshotOutputSettings. # noqa: E501
- Return type
bool
- property show_legend¶
Gets the show_legend of this ScreenshotOutputSettings. # noqa: E501
- Returns
The show_legend of this ScreenshotOutputSettings. # noqa: E501
- Return type
bool
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.screenshot_report_properties module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.screenshot_report_properties.ScreenshotReportProperties(report_type='SCREENSHOT', model_settings=None, filters=None, camera_settings=None, output_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'camera_settings': 'cameraSettings', 'filters': 'filters', 'model_settings': 'modelSettings', 'output_settings': 'outputSettings', 'report_type': 'reportType'}¶
- property camera_settings¶
Gets the camera_settings of this ScreenshotReportProperties. # noqa: E501
- Returns
The camera_settings of this ScreenshotReportProperties. # noqa: E501
- Return type
OneOfCameraSettings
- property filters¶
Gets the filters of this ScreenshotReportProperties. # noqa: E501
- Returns
The filters of this ScreenshotReportProperties. # noqa: E501
- Return type
- property model_settings¶
Gets the model_settings of this ScreenshotReportProperties. # noqa: E501
- Returns
The model_settings of this ScreenshotReportProperties. # noqa: E501
- Return type
- openapi_types = {'camera_settings': 'OneOfCameraSettings', 'filters': 'Filters', 'model_settings': 'ModelSettings', 'output_settings': 'ScreenshotOutputSettings', 'report_type': 'str'}¶
- property output_settings¶
Gets the output_settings of this ScreenshotReportProperties. # noqa: E501
- Returns
The output_settings of this ScreenshotReportProperties. # noqa: E501
- Return type
- property report_type¶
Gets the report_type of this ScreenshotReportProperties. # noqa: E501
- Returns
The report_type of this ScreenshotReportProperties. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.seed_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.seed_settings.SeedSettings(center=None, normal=None, horizontal_dimension=10, vertical_dimension=10, spacing=None, size=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center': 'center', 'horizontal_dimension': 'horizontalDimension', 'normal': 'normal', 'size': 'size', 'spacing': 'spacing', 'vertical_dimension': 'verticalDimension'}¶
- property center¶
Gets the center of this SeedSettings. # noqa: E501
- Returns
The center of this SeedSettings. # noqa: E501
- Return type
- property horizontal_dimension¶
Gets the horizontal_dimension of this SeedSettings. # noqa: E501
Number of seed points in the horizontal direction. # noqa: E501
- Returns
The horizontal_dimension of this SeedSettings. # noqa: E501
- Return type
int
- property normal¶
Gets the normal of this SeedSettings. # noqa: E501
- Returns
The normal of this SeedSettings. # noqa: E501
- Return type
- openapi_types = {'center': 'Vector3D', 'horizontal_dimension': 'int', 'normal': 'Vector3D', 'size': 'float', 'spacing': 'float', 'vertical_dimension': 'int'}¶
- property size¶
Gets the size of this SeedSettings. # noqa: E501
The radius of the particle trace geometry (cylinder, sphere, comet). Default is the extent of the bounding box of the moddel divided by 800. # noqa: E501
- Returns
The size of this SeedSettings. # noqa: E501
- Return type
float
- property spacing¶
Gets the spacing of this SeedSettings. # noqa: E501
The distance between the seed points. Default is size * 4. # noqa: E501
- Returns
The spacing of this SeedSettings. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vertical_dimension¶
Gets the vertical_dimension of this SeedSettings. # noqa: E501
Number of seed points in the vertical direction. # noqa: E501
- Returns
The vertical_dimension of this SeedSettings. # noqa: E501
- Return type
int
simscale_sdk.models.semi_open_boundary_ray_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.semi_open_boundary_ray_bc.SemiOpenBoundaryRayBC(type='SEMI_OPEN_BOUNDARY_RAY', emissivity=None, transmissivity=None, farfield_black_body_temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'emissivity': 'emissivity', 'farfield_black_body_temperature': 'farfieldBlackBodyTemperature', 'transmissivity': 'transmissivity', 'type': 'type'}¶
- property emissivity¶
Gets the emissivity of this SemiOpenBoundaryRayBC. # noqa: E501
- Returns
The emissivity of this SemiOpenBoundaryRayBC. # noqa: E501
- Return type
float
- property farfield_black_body_temperature¶
Gets the farfield_black_body_temperature of this SemiOpenBoundaryRayBC. # noqa: E501
- Returns
The farfield_black_body_temperature of this SemiOpenBoundaryRayBC. # noqa: E501
- Return type
- openapi_types = {'emissivity': 'float', 'farfield_black_body_temperature': 'DimensionalTemperature', 'transmissivity': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property transmissivity¶
Gets the transmissivity of this SemiOpenBoundaryRayBC. # noqa: E501
- Returns
The transmissivity of this SemiOpenBoundaryRayBC. # noqa: E501
- Return type
float
- property type¶
Gets the type of this SemiOpenBoundaryRayBC. # noqa: E501
Schema name: SemiOpenBoundaryRayBC # noqa: E501
- Returns
The type of this SemiOpenBoundaryRayBC. # noqa: E501
- Return type
str
simscale_sdk.models.set_value_position_tolerance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.set_value_position_tolerance.SetValuePositionTolerance(type='SET_VALUE', tolerance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'tolerance': 'tolerance', 'type': 'type'}¶
- openapi_types = {'tolerance': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property tolerance¶
Gets the tolerance of this SetValuePositionTolerance. # noqa: E501
- Returns
The tolerance of this SetValuePositionTolerance. # noqa: E501
- Return type
- property type¶
Gets the type of this SetValuePositionTolerance. # noqa: E501
Schema name: SetValuePositionTolerance # noqa: E501
- Returns
The type of this SetValuePositionTolerance. # noqa: E501
- Return type
str
simscale_sdk.models.shape_animation_output_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.shape_animation_output_settings.ShapeAnimationOutputSettings(name=None, format='GIF', resolution=None, frame_rate=20, show_legend=True, show_cube=True, background_color=None, type=None, frame_index=None, steps=30, range='FULL', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'background_color': 'backgroundColor', 'format': 'format', 'frame_index': 'frameIndex', 'frame_rate': 'frameRate', 'name': 'name', 'range': 'range', 'resolution': 'resolution', 'show_cube': 'showCube', 'show_legend': 'showLegend', 'steps': 'steps', 'type': 'type'}¶
- property background_color¶
Gets the background_color of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The background_color of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
- property format¶
Gets the format of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The format of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
str
- property frame_index¶
Gets the frame_index of this ShapeAnimationOutputSettings. # noqa: E501
Frame (or frequency) for which to create a mode shape animation.Default is the last frame in the result. # noqa: E501
- Returns
The frame_index of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
int
- property frame_rate¶
Gets the frame_rate of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The frame_rate of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
int
- property name¶
Gets the name of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The name of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
str
- openapi_types = {'background_color': 'Color', 'format': 'str', 'frame_index': 'int', 'frame_rate': 'int', 'name': 'str', 'range': 'str', 'resolution': 'ResolutionInfo', 'show_cube': 'bool', 'show_legend': 'bool', 'steps': 'int', 'type': 'str'}¶
- property range¶
Gets the range of this ShapeAnimationOutputSettings. # noqa: E501
How to deform the model for the animation. FULL implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape; do the same for the negative maximum deformation, then back (x_0 -> +x_max -> x_0 -> -x_max -> x_0). HALF implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape (x_0 -> +x_max -> x_0). QUARTER implies animating from the original, undeformed shape to the maxiumum displaced position (x_0 -> +x_max) # noqa: E501
- Returns
The range of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
str
- property resolution¶
Gets the resolution of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The resolution of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
- property show_cube¶
Gets the show_cube of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The show_cube of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
bool
- property show_legend¶
Gets the show_legend of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The show_legend of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
bool
- property steps¶
Gets the steps of this ShapeAnimationOutputSettings. # noqa: E501
The number of steps to generate for the shape animation # noqa: E501
- Returns
The steps of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ShapeAnimationOutputSettings. # noqa: E501
- Returns
The type of this ShapeAnimationOutputSettings. # noqa: E501
- Return type
str
simscale_sdk.models.shape_animation_output_settings_all_of module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.shape_animation_output_settings_all_of.ShapeAnimationOutputSettingsAllOf(type=None, frame_index=None, steps=30, range='FULL', background_color=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'background_color': 'backgroundColor', 'frame_index': 'frameIndex', 'range': 'range', 'steps': 'steps', 'type': 'type'}¶
- property background_color¶
Gets the background_color of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The background_color of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Return type
- property frame_index¶
Gets the frame_index of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
Frame (or frequency) for which to create a mode shape animation.Default is the last frame in the result. # noqa: E501
- Returns
The frame_index of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- openapi_types = {'background_color': 'Color', 'frame_index': 'int', 'range': 'str', 'steps': 'int', 'type': 'str'}¶
- property range¶
Gets the range of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
How to deform the model for the animation. FULL implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape; do the same for the negative maximum deformation, then back (x_0 -> +x_max -> x_0 -> -x_max -> x_0). HALF implies animating from the original, undeformed shape to the maximum displaced position, then back to original shape (x_0 -> +x_max -> x_0). QUARTER implies animating from the original, undeformed shape to the maxiumum displaced position (x_0 -> +x_max) # noqa: E501
- Returns
The range of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Return type
str
- property steps¶
Gets the steps of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
The number of steps to generate for the shape animation # noqa: E501
- Returns
The steps of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The type of this ShapeAnimationOutputSettingsAllOf. # noqa: E501
- Return type
str
simscale_sdk.models.ship_design_analysis_sbm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.ship_design_analysis_sbm.ShipDesignAnalysisSBM(type='SHIP_DESIGN_ANALYSIS', name=None, center_of_gravity=None, model_scale_ratio=None, max_roll_amplitude=None, min_roll_amplitude=None, heave_amplitude=None, sway_amplitude=None, damping_coefficient=None, time_period_for_liquid=None, natural_period_of_ship=None, reference_time_step=None, increase_in_liquid_per_time_step=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center_of_gravity': 'centerOfGravity', 'damping_coefficient': 'dampingCoefficient', 'heave_amplitude': 'heaveAmplitude', 'increase_in_liquid_per_time_step': 'increaseInLiquidPerTimeStep', 'max_roll_amplitude': 'maxRollAmplitude', 'min_roll_amplitude': 'minRollAmplitude', 'model_scale_ratio': 'modelScaleRatio', 'name': 'name', 'natural_period_of_ship': 'naturalPeriodOfShip', 'reference_time_step': 'referenceTimeStep', 'sway_amplitude': 'swayAmplitude', 'time_period_for_liquid': 'timePeriodForLiquid', 'type': 'type'}¶
- property center_of_gravity¶
Gets the center_of_gravity of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The center_of_gravity of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- property damping_coefficient¶
Gets the damping_coefficient of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The damping_coefficient of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
float
- property heave_amplitude¶
Gets the heave_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The heave_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- property increase_in_liquid_per_time_step¶
Gets the increase_in_liquid_per_time_step of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The increase_in_liquid_per_time_step of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
float
- property max_roll_amplitude¶
Gets the max_roll_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The max_roll_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- property min_roll_amplitude¶
Gets the min_roll_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The min_roll_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- property model_scale_ratio¶
Gets the model_scale_ratio of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The model_scale_ratio of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
float
- property name¶
Gets the name of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The name of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
str
- property natural_period_of_ship¶
Gets the natural_period_of_ship of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The natural_period_of_ship of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- openapi_types = {'center_of_gravity': 'DimensionalVectorLength', 'damping_coefficient': 'float', 'heave_amplitude': 'DimensionalLength', 'increase_in_liquid_per_time_step': 'float', 'max_roll_amplitude': 'DimensionalAngle', 'min_roll_amplitude': 'DimensionalAngle', 'model_scale_ratio': 'float', 'name': 'str', 'natural_period_of_ship': 'DimensionalTime', 'reference_time_step': 'DimensionalTime', 'sway_amplitude': 'DimensionalLength', 'time_period_for_liquid': 'DimensionalTime', 'type': 'str'}¶
- property reference_time_step¶
Gets the reference_time_step of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The reference_time_step of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- property sway_amplitude¶
Gets the sway_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The sway_amplitude of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- property time_period_for_liquid¶
Gets the time_period_for_liquid of this ShipDesignAnalysisSBM. # noqa: E501
- Returns
The time_period_for_liquid of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ShipDesignAnalysisSBM. # noqa: E501
Schema name: ShipDesignAnalysisSBM # noqa: E501
- Returns
The type of this ShipDesignAnalysisSBM. # noqa: E501
- Return type
str
simscale_sdk.models.signed_von_mises_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.signed_von_mises_stress_type.SignedVonMisesStressType(type='SIGNED_VON_MISES', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SignedVonMisesStressType. # noqa: E501
Schema name: SignedVonMisesStressType # noqa: E501
- Returns
The type of this SignedVonMisesStressType. # noqa: E501
- Return type
str
simscale_sdk.models.signorini_hyper_elastic_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.signorini_hyper_elastic_model.SignoriniHyperElasticModel(type='SIGNORINI', c10=None, c01=None, c20=None, d1=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'c01': 'c01', 'c10': 'c10', 'c20': 'c20', 'd1': 'd1', 'type': 'type'}¶
- property c01¶
Gets the c01 of this SignoriniHyperElasticModel. # noqa: E501
- Returns
The c01 of this SignoriniHyperElasticModel. # noqa: E501
- Return type
- property c10¶
Gets the c10 of this SignoriniHyperElasticModel. # noqa: E501
- Returns
The c10 of this SignoriniHyperElasticModel. # noqa: E501
- Return type
- property c20¶
Gets the c20 of this SignoriniHyperElasticModel. # noqa: E501
- Returns
The c20 of this SignoriniHyperElasticModel. # noqa: E501
- Return type
- property d1¶
Gets the d1 of this SignoriniHyperElasticModel. # noqa: E501
- Returns
The d1 of this SignoriniHyperElasticModel. # noqa: E501
- Return type
- openapi_types = {'c01': 'DimensionalPressure', 'c10': 'DimensionalPressure', 'c20': 'DimensionalPressure', 'd1': 'DimensionalInvPressure', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SignoriniHyperElasticModel. # noqa: E501
<p>Choose the hyperelastic material model that should be used. All models derive the stress-strain relation from a strain energy function defined by the material model parameters.</p> Schema name: SignoriniHyperElasticModel # noqa: E501
- Returns
The type of this SignoriniHyperElasticModel. # noqa: E501
- Return type
str
simscale_sdk.models.silver_birch module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.silver_birch.SilverBirch(type='SILVER_BIRCH', average_tree_height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_tree_height': 'averageTreeHeight', 'type': 'type'}¶
- property average_tree_height¶
Gets the average_tree_height of this SilverBirch. # noqa: E501
- Returns
The average_tree_height of this SilverBirch. # noqa: E501
- Return type
- openapi_types = {'average_tree_height': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SilverBirch. # noqa: E501
Schema name: SilverBirch # noqa: E501
- Returns
The type of this SilverBirch. # noqa: E501
- Return type
str
simscale_sdk.models.simerics_analysis module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simerics_analysis.SimericsAnalysis(type='SIMERICS_ANALYSIS', model=None, materials=None, is_compressible=None, cavitation_model=None, turbulence_model=None, time_dependency=None, boundary_conditions=None, advanced_concepts=None, simulation_control=None, result_control=None, mesh_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_concepts¶
Gets the advanced_concepts of this SimericsAnalysis. # noqa: E501
- Returns
The advanced_concepts of this SimericsAnalysis. # noqa: E501
- Return type
- attribute_map = {'advanced_concepts': 'advancedConcepts', 'boundary_conditions': 'boundaryConditions', 'cavitation_model': 'cavitationModel', 'is_compressible': 'isCompressible', 'materials': 'materials', 'mesh_settings': 'meshSettings', 'model': 'model', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'turbulence_model': 'turbulenceModel', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this SimericsAnalysis. # noqa: E501
- Returns
The boundary_conditions of this SimericsAnalysis. # noqa: E501
- Return type
list[OneOfSimericsAnalysisBoundaryConditions]
- property cavitation_model¶
Gets the cavitation_model of this SimericsAnalysis. # noqa: E501
- Returns
The cavitation_model of this SimericsAnalysis. # noqa: E501
- Return type
str
- property is_compressible¶
Gets the is_compressible of this SimericsAnalysis. # noqa: E501
- Returns
The is_compressible of this SimericsAnalysis. # noqa: E501
- Return type
bool
- property materials¶
Gets the materials of this SimericsAnalysis. # noqa: E501
- Returns
The materials of this SimericsAnalysis. # noqa: E501
- Return type
- property mesh_settings¶
Gets the mesh_settings of this SimericsAnalysis. # noqa: E501
- Returns
The mesh_settings of this SimericsAnalysis. # noqa: E501
- Return type
OneOfSimericsAnalysisMeshSettings
- property model¶
Gets the model of this SimericsAnalysis. # noqa: E501
- Returns
The model of this SimericsAnalysis. # noqa: E501
- Return type
- openapi_types = {'advanced_concepts': 'AdvancedConcepts', 'boundary_conditions': 'list[OneOfSimericsAnalysisBoundaryConditions]', 'cavitation_model': 'str', 'is_compressible': 'bool', 'materials': 'SimericsFluidMaterials', 'mesh_settings': 'OneOfSimericsAnalysisMeshSettings', 'model': 'FluidModel', 'result_control': 'FluidResultControls', 'simulation_control': 'FluidSimulationControl', 'time_dependency': 'OneOfSimericsAnalysisTimeDependency', 'turbulence_model': 'str', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this SimericsAnalysis. # noqa: E501
- Returns
The result_control of this SimericsAnalysis. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this SimericsAnalysis. # noqa: E501
- Returns
The simulation_control of this SimericsAnalysis. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this SimericsAnalysis. # noqa: E501
- Returns
The time_dependency of this SimericsAnalysis. # noqa: E501
- Return type
OneOfSimericsAnalysisTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property turbulence_model¶
Gets the turbulence_model of this SimericsAnalysis. # noqa: E501
Choose a turbulence model for your CFD analysis:<ul><li><strong>No turbulence</strong>: Laminar</li><li><strong>RANS</strong>: <a href=’https://www.simscale.com/docs/simulation-setup/global-settings/k-epsilon/’ target=’_blank’>k-epsilon</a></ul><p><p><a href=’https://www.simscale.com/blog/2017/12/turbulence-cfd-analysis/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The turbulence_model of this SimericsAnalysis. # noqa: E501
- Return type
str
- property type¶
Gets the type of this SimericsAnalysis. # noqa: E501
Schema name: SimericsAnalysis # noqa: E501
- Returns
The type of this SimericsAnalysis. # noqa: E501
- Return type
str
simscale_sdk.models.simerics_fluid_materials module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simerics_fluid_materials.SimericsFluidMaterials(fluids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fluids': 'fluids'}¶
- property fluids¶
Gets the fluids of this SimericsFluidMaterials. # noqa: E501
- Returns
The fluids of this SimericsFluidMaterials. # noqa: E501
- Return type
list[OneOfSimericsFluidMaterialsFluids]
- openapi_types = {'fluids': 'list[OneOfSimericsFluidMaterialsFluids]'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.simmetrix_boundary_layer_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simmetrix_boundary_layer_refinement.SimmetrixBoundaryLayerRefinement(type='SIMMETRIX_BOUNDARY_LAYER_V13', name=None, number_of_layers=None, total_relative_thickness=None, layer_type=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'layer_type': 'layerType', 'name': 'name', 'number_of_layers': 'numberOfLayers', 'topological_reference': 'topologicalReference', 'total_relative_thickness': 'totalRelativeThickness', 'type': 'type'}¶
- property layer_type¶
Gets the layer_type of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Returns
The layer_type of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Return type
OneOfSimmetrixBoundaryLayerRefinementLayerType
- property name¶
Gets the name of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Returns
The name of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Return type
str
- property number_of_layers¶
Gets the number_of_layers of this SimmetrixBoundaryLayerRefinement. # noqa: E501
The <i>Number of layers</i> defines how many prismatic boundary layers should be created. 3 is default. # noqa: E501
- Returns
The number_of_layers of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Return type
int
- openapi_types = {'layer_type': 'OneOfSimmetrixBoundaryLayerRefinementLayerType', 'name': 'str', 'number_of_layers': 'int', 'topological_reference': 'TopologicalReference', 'total_relative_thickness': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Returns
The topological_reference of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Return type
- property total_relative_thickness¶
Gets the total_relative_thickness of this SimmetrixBoundaryLayerRefinement. # noqa: E501
It defines the thickness of all prismatic boundary layers combined in relation to the local element size.<img src=”/spec/resources/help/imgs/simmetrix-overall-layer-thickness.png” class=”helpPopupImage”/>Example 3-layer thickness of 40% (0.4) of the local mesh size. # noqa: E501
- Returns
The total_relative_thickness of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Return type
float
- property type¶
Gets the type of this SimmetrixBoundaryLayerRefinement. # noqa: E501
<p><a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#layer-inflation’ target=’_blank’><b>Layer inflation</b></a> allows the creation of prismatic boundary layers for certain mesh regions.</p><p>Prismatic layers are mostly used in CFD simulations on no-slip walls in order to efficiently capture the boundary layer velocity profile, but they may be also used in certain structural simulations like stamping or deep-drawing processes.</p><p><img src=”/spec/resources/help/imgs/simmetrix-layers.png” class=”helpPopupImage”/> The figure shows a sample mesh with boundary layers added.</p> Schema name: SimmetrixBoundaryLayerRefinement # noqa: E501
- Returns
The type of this SimmetrixBoundaryLayerRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.simmetrix_cell_zones module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simmetrix_cell_zones.SimmetrixCellZones(type='SIMMETRIX_CELL_ZONES', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this SimmetrixCellZones. # noqa: E501
- Returns
The name of this SimmetrixCellZones. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SimmetrixCellZones. # noqa: E501
- Returns
The topological_reference of this SimmetrixCellZones. # noqa: E501
- Return type
- property type¶
Gets the type of this SimmetrixCellZones. # noqa: E501
Schema name: SimmetrixCellZones # noqa: E501
- Returns
The type of this SimmetrixCellZones. # noqa: E501
- Return type
str
simscale_sdk.models.simmetrix_local_sizing_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simmetrix_local_sizing_refinement.SimmetrixLocalSizingRefinement(type='SIMMETRIX_LOCAL_SIZING_V10', name=None, max_element_size=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_element_size': 'maxElementSize', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property max_element_size¶
Gets the max_element_size of this SimmetrixLocalSizingRefinement. # noqa: E501
- Returns
The max_element_size of this SimmetrixLocalSizingRefinement. # noqa: E501
- Return type
- property name¶
Gets the name of this SimmetrixLocalSizingRefinement. # noqa: E501
- Returns
The name of this SimmetrixLocalSizingRefinement. # noqa: E501
- Return type
str
- openapi_types = {'max_element_size': 'DimensionalLength', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SimmetrixLocalSizingRefinement. # noqa: E501
- Returns
The topological_reference of this SimmetrixLocalSizingRefinement. # noqa: E501
- Return type
- property type¶
Gets the type of this SimmetrixLocalSizingRefinement. # noqa: E501
Refine specific faces of interest or complex geometrical shapes by defining a local element size. This will ensure a relatively uniform mesh. Schema name: SimmetrixLocalSizingRefinement # noqa: E501
- Returns
The type of this SimmetrixLocalSizingRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.simmetrix_meshing_fluid module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simmetrix_meshing_fluid.SimmetrixMeshingFluid(type='SIMMETRIX_MESHING_FLUID_V16', sizing=None, refinements=None, cell_zones=None, automatic_layer_settings=None, physics_based_meshing=None, hex_core=None, num_of_processors=None, advanced_simmetrix_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_simmetrix_settings¶
Gets the advanced_simmetrix_settings of this SimmetrixMeshingFluid. # noqa: E501
- Returns
The advanced_simmetrix_settings of this SimmetrixMeshingFluid. # noqa: E501
- Return type
- attribute_map = {'advanced_simmetrix_settings': 'advancedSimmetrixSettings', 'automatic_layer_settings': 'automaticLayerSettings', 'cell_zones': 'cellZones', 'hex_core': 'hexCore', 'num_of_processors': 'numOfProcessors', 'physics_based_meshing': 'physicsBasedMeshing', 'refinements': 'refinements', 'sizing': 'sizing', 'type': 'type'}¶
- property automatic_layer_settings¶
Gets the automatic_layer_settings of this SimmetrixMeshingFluid. # noqa: E501
- Returns
The automatic_layer_settings of this SimmetrixMeshingFluid. # noqa: E501
- Return type
OneOfSimmetrixMeshingFluidAutomaticLayerSettings
- property cell_zones¶
Gets the cell_zones of this SimmetrixMeshingFluid. # noqa: E501
- Returns
The cell_zones of this SimmetrixMeshingFluid. # noqa: E501
- Return type
list[SimmetrixCellZones]
- property hex_core¶
Gets the hex_core of this SimmetrixMeshingFluid. # noqa: E501
<p>If <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#hexcore’ target=’_blank’><b>Hex element core</b></a> is activated, the interior of the mesh gets covered by <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#hexcore’ target=’_blank’><b>hexahedral elements</b></a>. The transition to the triangulated surface mesh is covered by tetrahedral and pyramid elements.<img src=”/spec/resources/help/imgs/simmetrix-hexcore.png” class=”helpPopupImage”/>Meshclip through a hex-core mesh.</p> # noqa: E501
- Returns
The hex_core of this SimmetrixMeshingFluid. # noqa: E501
- Return type
bool
- property num_of_processors¶
Gets the num_of_processors of this SimmetrixMeshingFluid. # noqa: E501
<p>Selecting more processor cores might speed up the meshing process. Choosing a smaller computation instance will save core hours. <a href=’https://www.simscale.com/docs/simulation-setup/meshing/#number-of-processors’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The num_of_processors of this SimmetrixMeshingFluid. # noqa: E501
- Return type
int
- openapi_types = {'advanced_simmetrix_settings': 'AdvancedSimmetrixFluidSettings', 'automatic_layer_settings': 'OneOfSimmetrixMeshingFluidAutomaticLayerSettings', 'cell_zones': 'list[SimmetrixCellZones]', 'hex_core': 'bool', 'num_of_processors': 'int', 'physics_based_meshing': 'bool', 'refinements': 'list[OneOfSimmetrixMeshingFluidRefinements]', 'sizing': 'OneOfSimmetrixMeshingFluidSizing', 'type': 'str'}¶
- property physics_based_meshing¶
Gets the physics_based_meshing of this SimmetrixMeshingFluid. # noqa: E501
Physics-based meshing takes setup information like materials, boundary conditions, and source terms into account to size the mesh accordingly. When enabled, the following adaptations will be made:</p><ul><li>Refinements on inlets and outlets</li><li>Different sizing for solid and fluid regions in CHT simulations</li></ul> <br>When toggled on users don’t have to worry about creating a <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control/’ target=’_blank’>separate cell zone</a>. # noqa: E501
- Returns
The physics_based_meshing of this SimmetrixMeshingFluid. # noqa: E501
- Return type
bool
- property refinements¶
Gets the refinements of this SimmetrixMeshingFluid. # noqa: E501
- Returns
The refinements of this SimmetrixMeshingFluid. # noqa: E501
- Return type
list[OneOfSimmetrixMeshingFluidRefinements]
- property sizing¶
Gets the sizing of this SimmetrixMeshingFluid. # noqa: E501
- Returns
The sizing of this SimmetrixMeshingFluid. # noqa: E501
- Return type
OneOfSimmetrixMeshingFluidSizing
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimmetrixMeshingFluid. # noqa: E501
Schema name: SimmetrixMeshingFluid # noqa: E501
- Returns
The type of this SimmetrixMeshingFluid. # noqa: E501
- Return type
str
simscale_sdk.models.simmetrix_meshing_solid module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simmetrix_meshing_solid.SimmetrixMeshingSolid(type='SIMMETRIX_MESHING_SOLID', sizing=None, refinements=None, second_order=None, enable_shell_meshing=None, surface_element_type=None, num_of_processors=None, advanced_simmetrix_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property advanced_simmetrix_settings¶
Gets the advanced_simmetrix_settings of this SimmetrixMeshingSolid. # noqa: E501
- Returns
The advanced_simmetrix_settings of this SimmetrixMeshingSolid. # noqa: E501
- Return type
- attribute_map = {'advanced_simmetrix_settings': 'advancedSimmetrixSettings', 'enable_shell_meshing': 'enableShellMeshing', 'num_of_processors': 'numOfProcessors', 'refinements': 'refinements', 'second_order': 'secondOrder', 'sizing': 'sizing', 'surface_element_type': 'surfaceElementType', 'type': 'type'}¶
- property enable_shell_meshing¶
Gets the enable_shell_meshing of this SimmetrixMeshingSolid. # noqa: E501
- Returns
The enable_shell_meshing of this SimmetrixMeshingSolid. # noqa: E501
- Return type
bool
- property num_of_processors¶
Gets the num_of_processors of this SimmetrixMeshingSolid. # noqa: E501
<p>Selecting more processor cores might speed up the meshing process. Choosing a smaller computation instance will save core hours. <a href=’https://www.simscale.com/docs/simulation-setup/meshing/#number-of-processors’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The num_of_processors of this SimmetrixMeshingSolid. # noqa: E501
- Return type
int
- openapi_types = {'advanced_simmetrix_settings': 'AdvancedSimmetrixSolidSettings', 'enable_shell_meshing': 'bool', 'num_of_processors': 'int', 'refinements': 'list[OneOfSimmetrixMeshingSolidRefinements]', 'second_order': 'bool', 'sizing': 'OneOfSimmetrixMeshingSolidSizing', 'surface_element_type': 'str', 'type': 'str'}¶
- property refinements¶
Gets the refinements of this SimmetrixMeshingSolid. # noqa: E501
- Returns
The refinements of this SimmetrixMeshingSolid. # noqa: E501
- Return type
list[OneOfSimmetrixMeshingSolidRefinements]
- property second_order¶
Gets the second_order of this SimmetrixMeshingSolid. # noqa: E501
<p>The <a href=’https://www.simscale.com/docs/simulation-setup/meshing/standard/#order’ target=’_blank’><b>mesh order</b></a> defines the shape and the number of nodes of the mesh elements. For a fast, rough analysis choose <i>first order</i> only. Activate <i>2nd order elements</i> for higher quality results</p> # noqa: E501
- Returns
The second_order of this SimmetrixMeshingSolid. # noqa: E501
- Return type
bool
- property sizing¶
Gets the sizing of this SimmetrixMeshingSolid. # noqa: E501
- Returns
The sizing of this SimmetrixMeshingSolid. # noqa: E501
- Return type
OneOfSimmetrixMeshingSolidSizing
- property surface_element_type¶
Gets the surface_element_type of this SimmetrixMeshingSolid. # noqa: E501
- Returns
The surface_element_type of this SimmetrixMeshingSolid. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimmetrixMeshingSolid. # noqa: E501
Schema name: SimmetrixMeshingSolid # noqa: E501
- Returns
The type of this SimmetrixMeshingSolid. # noqa: E501
- Return type
str
simscale_sdk.models.simple_decompose_algorithm module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simple_decompose_algorithm.SimpleDecomposeAlgorithm(type='SIMPLE', delta=None, num_subdomain_x=None, num_subdomain_y=None, num_subdomain_z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'delta': 'delta', 'num_subdomain_x': 'numSubdomainX', 'num_subdomain_y': 'numSubdomainY', 'num_subdomain_z': 'numSubdomainZ', 'type': 'type'}¶
- property delta¶
Gets the delta of this SimpleDecomposeAlgorithm. # noqa: E501
Delta is cell skew factor. It represents the cell skewness allowed at the decomposed domain boundaries and is generally kept below 10^{-2}. <a href=’https://www.simscale.com/docs/simulation-setup/simulation-control/’ target=’_blank’>Learn more</a>. # noqa: E501
- Returns
The delta of this SimpleDecomposeAlgorithm. # noqa: E501
- Return type
float
- property num_subdomain_x¶
Gets the num_subdomain_x of this SimpleDecomposeAlgorithm. # noqa: E501
<p>Define the number of subdomains the mesh is split into in the specific direction.</p> # noqa: E501
- Returns
The num_subdomain_x of this SimpleDecomposeAlgorithm. # noqa: E501
- Return type
int
- property num_subdomain_y¶
Gets the num_subdomain_y of this SimpleDecomposeAlgorithm. # noqa: E501
<p>Define the number of subdomains the mesh is split into in the specific direction.</p> # noqa: E501
- Returns
The num_subdomain_y of this SimpleDecomposeAlgorithm. # noqa: E501
- Return type
int
- property num_subdomain_z¶
Gets the num_subdomain_z of this SimpleDecomposeAlgorithm. # noqa: E501
<p>Define the number of subdomains the mesh is split into in the specific direction.</p> # noqa: E501
- Returns
The num_subdomain_z of this SimpleDecomposeAlgorithm. # noqa: E501
- Return type
int
- openapi_types = {'delta': 'float', 'num_subdomain_x': 'int', 'num_subdomain_y': 'int', 'num_subdomain_z': 'int', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimpleDecomposeAlgorithm. # noqa: E501
Schema name: SimpleDecomposeAlgorithm # noqa: E501
- Returns
The type of this SimpleDecomposeAlgorithm. # noqa: E501
- Return type
str
simscale_sdk.models.simulation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation.Simulation(simulation_id=None, name=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'simulation_id': 'simulationId'}¶
- property name¶
Gets the name of this Simulation. # noqa: E501
The name of the simulation. # noqa: E501
- Returns
The name of this Simulation. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'simulation_id': 'str'}¶
- property simulation_id¶
Gets the simulation_id of this Simulation. # noqa: E501
- Returns
The simulation_id of this Simulation. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.simulation_run module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run.SimulationRun(run_id=None, name=None, created_at=None, started_at=None, finished_at=None, duration=None, compute_resource=None, status=None, progress=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'compute_resource': 'computeResource', 'created_at': 'createdAt', 'duration': 'duration', 'finished_at': 'finishedAt', 'name': 'name', 'progress': 'progress', 'run_id': 'runId', 'started_at': 'startedAt', 'status': 'status'}¶
- property compute_resource¶
Gets the compute_resource of this SimulationRun. # noqa: E501
- Returns
The compute_resource of this SimulationRun. # noqa: E501
- Return type
- property created_at¶
Gets the created_at of this SimulationRun. # noqa: E501
The time when the simulation run was created. # noqa: E501
- Returns
The created_at of this SimulationRun. # noqa: E501
- Return type
datetime
- property duration¶
Gets the duration of this SimulationRun. # noqa: E501
The actual duration of the simulation run. # noqa: E501
- Returns
The duration of this SimulationRun. # noqa: E501
- Return type
str
- property finished_at¶
Gets the finished_at of this SimulationRun. # noqa: E501
The time when the simulation run was finished. # noqa: E501
- Returns
The finished_at of this SimulationRun. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this SimulationRun. # noqa: E501
The name of the simulation run. # noqa: E501
- Returns
The name of this SimulationRun. # noqa: E501
- Return type
str
- openapi_types = {'compute_resource': 'SimulationRunComputeResource', 'created_at': 'datetime', 'duration': 'str', 'finished_at': 'datetime', 'name': 'str', 'progress': 'float', 'run_id': 'str', 'started_at': 'datetime', 'status': 'Status'}¶
- property progress¶
Gets the progress of this SimulationRun. # noqa: E501
The current progress while the simulation run is in progress. # noqa: E501
- Returns
The progress of this SimulationRun. # noqa: E501
- Return type
float
- property run_id¶
Gets the run_id of this SimulationRun. # noqa: E501
- Returns
The run_id of this SimulationRun. # noqa: E501
- Return type
str
- property started_at¶
Gets the started_at of this SimulationRun. # noqa: E501
The time when the simulation run was started. # noqa: E501
- Returns
The started_at of this SimulationRun. # noqa: E501
- Return type
datetime
- property status¶
Gets the status of this SimulationRun. # noqa: E501
- Returns
The status of this SimulationRun. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.simulation_run_compute_resource module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_compute_resource.SimulationRunComputeResource(type=None, value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'ComputeResourceType', 'value': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimulationRunComputeResource. # noqa: E501
- Returns
The type of this SimulationRunComputeResource. # noqa: E501
- Return type
- property value¶
Gets the value of this SimulationRunComputeResource. # noqa: E501
- Returns
The value of this SimulationRunComputeResource. # noqa: E501
- Return type
float
simscale_sdk.models.simulation_run_result_convergence_plot module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_result_convergence_plot.SimulationRunResultConvergencePlot(type='CONVERGENCE_PLOT', result_id=None, category=None, direction=None, modified_at=None, download=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'category': 'category', 'direction': 'direction', 'download': 'download', 'modified_at': 'modifiedAt', 'result_id': 'resultId', 'type': 'type'}¶
- property category¶
Gets the category of this SimulationRunResultConvergencePlot. # noqa: E501
The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc. # noqa: E501
- Returns
The category of this SimulationRunResultConvergencePlot. # noqa: E501
- Return type
str
- property direction¶
Gets the direction of this SimulationRunResultConvergencePlot. # noqa: E501
The result direction, only applies to Pedestrian Wind Comfort analysis # noqa: E501
- Returns
The direction of this SimulationRunResultConvergencePlot. # noqa: E501
- Return type
float
- property download¶
Gets the download of this SimulationRunResultConvergencePlot. # noqa: E501
- Returns
The download of this SimulationRunResultConvergencePlot. # noqa: E501
- Return type
- property modified_at¶
Gets the modified_at of this SimulationRunResultConvergencePlot. # noqa: E501
The time when the result was last modified. # noqa: E501
- Returns
The modified_at of this SimulationRunResultConvergencePlot. # noqa: E501
- Return type
datetime
- openapi_types = {'category': 'str', 'direction': 'float', 'download': 'SimulationRunResultDownload', 'modified_at': 'datetime', 'result_id': 'str', 'type': 'str'}¶
- property result_id¶
Gets the result_id of this SimulationRunResultConvergencePlot. # noqa: E501
The result ID # noqa: E501
- Returns
The result_id of this SimulationRunResultConvergencePlot. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimulationRunResultConvergencePlot. # noqa: E501
- Returns
The type of this SimulationRunResultConvergencePlot. # noqa: E501
- Return type
str
simscale_sdk.models.simulation_run_result_download module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_result_download.SimulationRunResultDownload(format=None, uncompressed_size_in_bytes=None, url=None, compression=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'compression': 'compression', 'format': 'format', 'uncompressed_size_in_bytes': 'uncompressedSizeInBytes', 'url': 'url'}¶
- property compression¶
Gets the compression of this SimulationRunResultDownload. # noqa: E501
The compression used for the result download archive. # noqa: E501
- Returns
The compression of this SimulationRunResultDownload. # noqa: E501
- Return type
str
- property format¶
Gets the format of this SimulationRunResultDownload. # noqa: E501
The result format. Valid values include OPEN_FOAM, ENSIGHT_GOLD, PVD, VTM, CSV. # noqa: E501
- Returns
The format of this SimulationRunResultDownload. # noqa: E501
- Return type
str
- openapi_types = {'compression': 'str', 'format': 'str', 'uncompressed_size_in_bytes': 'int', 'url': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property uncompressed_size_in_bytes¶
Gets the uncompressed_size_in_bytes of this SimulationRunResultDownload. # noqa: E501
The uncompressed size of the result content. # noqa: E501
- Returns
The uncompressed_size_in_bytes of this SimulationRunResultDownload. # noqa: E501
- Return type
int
- property url¶
Gets the url of this SimulationRunResultDownload. # noqa: E501
URL for downloading the result content. # noqa: E501
- Returns
The url of this SimulationRunResultDownload. # noqa: E501
- Return type
str
simscale_sdk.models.simulation_run_result_plot module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_result_plot.SimulationRunResultPlot(type='PLOT', result_id=None, category=None, direction=None, quantity=None, name=None, modified_at=None, download=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'category': 'category', 'direction': 'direction', 'download': 'download', 'modified_at': 'modifiedAt', 'name': 'name', 'quantity': 'quantity', 'result_id': 'resultId', 'type': 'type'}¶
- property category¶
Gets the category of this SimulationRunResultPlot. # noqa: E501
The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc. # noqa: E501
- Returns
The category of this SimulationRunResultPlot. # noqa: E501
- Return type
str
- property direction¶
Gets the direction of this SimulationRunResultPlot. # noqa: E501
The result direction, only applies to Pedestrian Wind Comfort analysis # noqa: E501
- Returns
The direction of this SimulationRunResultPlot. # noqa: E501
- Return type
float
- property download¶
Gets the download of this SimulationRunResultPlot. # noqa: E501
- Returns
The download of this SimulationRunResultPlot. # noqa: E501
- Return type
- property modified_at¶
Gets the modified_at of this SimulationRunResultPlot. # noqa: E501
The time when the result was last modified. # noqa: E501
- Returns
The modified_at of this SimulationRunResultPlot. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this SimulationRunResultPlot. # noqa: E501
The name that was defined for extra simulation result outputs # noqa: E501
- Returns
The name of this SimulationRunResultPlot. # noqa: E501
- Return type
str
- openapi_types = {'category': 'str', 'direction': 'float', 'download': 'SimulationRunResultDownload', 'modified_at': 'datetime', 'name': 'str', 'quantity': 'str', 'result_id': 'str', 'type': 'str'}¶
- property quantity¶
Gets the quantity of this SimulationRunResultPlot. # noqa: E501
The result quantity, only applies to plot result types. Valid values include ‘Ux’, ‘Uy’, ‘Uz’, ‘p’, ‘k’, ‘omega’, ‘T’, ‘displacement’, ‘von Mises stress’, etc. # noqa: E501
- Returns
The quantity of this SimulationRunResultPlot. # noqa: E501
- Return type
str
- property result_id¶
Gets the result_id of this SimulationRunResultPlot. # noqa: E501
The result ID # noqa: E501
- Returns
The result_id of this SimulationRunResultPlot. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimulationRunResultPlot. # noqa: E501
- Returns
The type of this SimulationRunResultPlot. # noqa: E501
- Return type
str
simscale_sdk.models.simulation_run_result_solution module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_result_solution.SimulationRunResultSolution(type='SOLUTION_FIELD', result_id=None, category=None, direction=None, modified_at=None, download=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'category': 'category', 'direction': 'direction', 'download': 'download', 'modified_at': 'modifiedAt', 'result_id': 'resultId', 'type': 'type'}¶
- property category¶
Gets the category of this SimulationRunResultSolution. # noqa: E501
The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc. # noqa: E501
- Returns
The category of this SimulationRunResultSolution. # noqa: E501
- Return type
str
- property direction¶
Gets the direction of this SimulationRunResultSolution. # noqa: E501
The result direction, only applies to Pedestrian Wind Comfort analysis # noqa: E501
- Returns
The direction of this SimulationRunResultSolution. # noqa: E501
- Return type
float
- property download¶
Gets the download of this SimulationRunResultSolution. # noqa: E501
- Returns
The download of this SimulationRunResultSolution. # noqa: E501
- Return type
- property modified_at¶
Gets the modified_at of this SimulationRunResultSolution. # noqa: E501
The time when the result was last modified. # noqa: E501
- Returns
The modified_at of this SimulationRunResultSolution. # noqa: E501
- Return type
datetime
- openapi_types = {'category': 'str', 'direction': 'float', 'download': 'SimulationRunResultDownload', 'modified_at': 'datetime', 'result_id': 'str', 'type': 'str'}¶
- property result_id¶
Gets the result_id of this SimulationRunResultSolution. # noqa: E501
The result ID # noqa: E501
- Returns
The result_id of this SimulationRunResultSolution. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimulationRunResultSolution. # noqa: E501
- Returns
The type of this SimulationRunResultSolution. # noqa: E501
- Return type
str
simscale_sdk.models.simulation_run_result_table module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_result_table.SimulationRunResultTable(type='TABLE', result_id=None, category=None, direction=None, name=None, modified_at=None, download=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'category': 'category', 'direction': 'direction', 'download': 'download', 'modified_at': 'modifiedAt', 'name': 'name', 'result_id': 'resultId', 'type': 'type'}¶
- property category¶
Gets the category of this SimulationRunResultTable. # noqa: E501
The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc. # noqa: E501
- Returns
The category of this SimulationRunResultTable. # noqa: E501
- Return type
str
- property direction¶
Gets the direction of this SimulationRunResultTable. # noqa: E501
The result direction, only applies to Pedestrian Wind Comfort analysis # noqa: E501
- Returns
The direction of this SimulationRunResultTable. # noqa: E501
- Return type
float
- property download¶
Gets the download of this SimulationRunResultTable. # noqa: E501
- Returns
The download of this SimulationRunResultTable. # noqa: E501
- Return type
- property modified_at¶
Gets the modified_at of this SimulationRunResultTable. # noqa: E501
The time when the result was last modified. # noqa: E501
- Returns
The modified_at of this SimulationRunResultTable. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this SimulationRunResultTable. # noqa: E501
The name that was defined for extra simulation result outputs # noqa: E501
- Returns
The name of this SimulationRunResultTable. # noqa: E501
- Return type
str
- openapi_types = {'category': 'str', 'direction': 'float', 'download': 'SimulationRunResultDownload', 'modified_at': 'datetime', 'name': 'str', 'result_id': 'str', 'type': 'str'}¶
- property result_id¶
Gets the result_id of this SimulationRunResultTable. # noqa: E501
The result ID # noqa: E501
- Returns
The result_id of this SimulationRunResultTable. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SimulationRunResultTable. # noqa: E501
- Returns
The type of this SimulationRunResultTable. # noqa: E501
- Return type
str
simscale_sdk.models.simulation_run_results module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_run_results.SimulationRunResults(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this SimulationRunResults. # noqa: E501
- Returns
The embedded of this SimulationRunResults. # noqa: E501
- Return type
list[OneOfSimulationRunResult]
- property links¶
Gets the links of this SimulationRunResults. # noqa: E501
- Returns
The links of this SimulationRunResults. # noqa: E501
- Return type
- property meta¶
Gets the meta of this SimulationRunResults. # noqa: E501
- Returns
The meta of this SimulationRunResults. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[OneOfSimulationRunResult]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.simulation_runs module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_runs.SimulationRuns(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this SimulationRuns. # noqa: E501
- Returns
The embedded of this SimulationRuns. # noqa: E501
- Return type
list[SimulationRun]
- property links¶
Gets the links of this SimulationRuns. # noqa: E501
- Returns
The links of this SimulationRuns. # noqa: E501
- Return type
- property meta¶
Gets the meta of this SimulationRuns. # noqa: E501
- Returns
The meta of this SimulationRuns. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[SimulationRun]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.simulation_spec module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulation_spec.SimulationSpec(simulation_id=None, name=None, version='9.0', created_at=None, modified_at=None, geometry_id=None, mesh_id=None, model=None, parameters=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'createdAt', 'geometry_id': 'geometryId', 'mesh_id': 'meshId', 'model': 'model', 'modified_at': 'modifiedAt', 'name': 'name', 'parameters': 'parameters', 'simulation_id': 'simulationId', 'version': 'version'}¶
- property created_at¶
Gets the created_at of this SimulationSpec. # noqa: E501
- Returns
The created_at of this SimulationSpec. # noqa: E501
- Return type
datetime
- property geometry_id¶
Gets the geometry_id of this SimulationSpec. # noqa: E501
- Returns
The geometry_id of this SimulationSpec. # noqa: E501
- Return type
str
- property mesh_id¶
Gets the mesh_id of this SimulationSpec. # noqa: E501
The generated mesh ID which is to be used in the simulation. This field should be left empty for analysis types that do not require a generated mesh like ‘INCOMPRESSIBLE_PACEFISH’, ‘WIND_COMFORT’, and ‘SIMERICS_ANALYSIS’. # noqa: E501
- Returns
The mesh_id of this SimulationSpec. # noqa: E501
- Return type
str
- property model¶
Gets the model of this SimulationSpec. # noqa: E501
- Returns
The model of this SimulationSpec. # noqa: E501
- Return type
- property modified_at¶
Gets the modified_at of this SimulationSpec. # noqa: E501
- Returns
The modified_at of this SimulationSpec. # noqa: E501
- Return type
datetime
- property name¶
Gets the name of this SimulationSpec. # noqa: E501
- Returns
The name of this SimulationSpec. # noqa: E501
- Return type
str
- openapi_types = {'created_at': 'datetime', 'geometry_id': 'str', 'mesh_id': 'str', 'model': 'Analysis', 'modified_at': 'datetime', 'name': 'str', 'parameters': 'dict(str, OneOfParameters)', 'simulation_id': 'str', 'version': 'str'}¶
- property parameters¶
Gets the parameters of this SimulationSpec. # noqa: E501
- Returns
The parameters of this SimulationSpec. # noqa: E501
- Return type
dict(str, OneOfParameters)
- property simulation_id¶
Gets the simulation_id of this SimulationSpec. # noqa: E501
- Returns
The simulation_id of this SimulationSpec. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property version¶
Gets the version of this SimulationSpec. # noqa: E501
- Returns
The version of this SimulationSpec. # noqa: E501
- Return type
str
simscale_sdk.models.simulations module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.simulations.Simulations(links=None, meta=None, embedded=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'embedded': '_embedded', 'links': '_links', 'meta': '_meta'}¶
- property embedded¶
Gets the embedded of this Simulations. # noqa: E501
- Returns
The embedded of this Simulations. # noqa: E501
- Return type
list[Simulation]
- property links¶
Gets the links of this Simulations. # noqa: E501
- Returns
The links of this Simulations. # noqa: E501
- Return type
- property meta¶
Gets the meta of this Simulations. # noqa: E501
- Returns
The meta of this Simulations. # noqa: E501
- Return type
- openapi_types = {'embedded': 'list[Simulation]', 'links': 'CollectionLinks', 'meta': 'CollectionMeta'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.single_error_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.single_error_response.SingleErrorResponse(severity=None, code=None, message=None, details=None, trace=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'code': 'code', 'details': 'details', 'message': 'message', 'severity': 'severity', 'trace': 'trace'}¶
- property code¶
Gets the code of this SingleErrorResponse. # noqa: E501
Code for e.g. programmatic handling of error conditions. # noqa: E501
- Returns
The code of this SingleErrorResponse. # noqa: E501
- Return type
str
- property details¶
Gets the details of this SingleErrorResponse. # noqa: E501
Additional data to interpret and handle the entry. # noqa: E501
- Returns
The details of this SingleErrorResponse. # noqa: E501
- Return type
dict(str, object)
- property message¶
Gets the message of this SingleErrorResponse. # noqa: E501
Human-readable description of the entry. # noqa: E501
- Returns
The message of this SingleErrorResponse. # noqa: E501
- Return type
str
- openapi_types = {'code': 'str', 'details': 'dict(str, object)', 'message': 'str', 'severity': 'LogSeverity', 'trace': 'str'}¶
- property severity¶
Gets the severity of this SingleErrorResponse. # noqa: E501
- Returns
The severity of this SingleErrorResponse. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property trace¶
Gets the trace of this SingleErrorResponse. # noqa: E501
- Returns
The trace of this SingleErrorResponse. # noqa: E501
- Return type
str
simscale_sdk.models.single_error_response_all_of module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.single_error_response_all_of.SingleErrorResponseAllOf(trace=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'trace': 'trace'}¶
- openapi_types = {'trace': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property trace¶
Gets the trace of this SingleErrorResponseAllOf. # noqa: E501
- Returns
The trace of this SingleErrorResponseAllOf. # noqa: E501
- Return type
str
simscale_sdk.models.single_frequency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.single_frequency.SingleFrequency(type='SINGLE', frequency=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'frequency': 'frequency', 'type': 'type'}¶
- property frequency¶
Gets the frequency of this SingleFrequency. # noqa: E501
- Returns
The frequency of this SingleFrequency. # noqa: E501
- Return type
- openapi_types = {'frequency': 'DimensionalFrequency', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SingleFrequency. # noqa: E501
<p>Set the frequencies for the harmonic excitation. Setting it to <b>single frequency</b> will only compute harmonic excitation on that frequency. To have harmonic excitations on multiple frequencies, please choose <b>frequency list</b>. </p> Schema name: SingleFrequency # noqa: E501
- Returns
The type of this SingleFrequency. # noqa: E501
- Return type
str
simscale_sdk.models.single_step_pseudo_time_stepping module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.single_step_pseudo_time_stepping.SingleStepPseudoTimeStepping(type='SINGLE_STEP', static_timesteps=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'static_timesteps': 'staticTimesteps', 'type': 'type'}¶
- openapi_types = {'static_timesteps': 'DimensionalTime', 'type': 'str'}¶
- property static_timesteps¶
Gets the static_timesteps of this SingleStepPseudoTimeStepping. # noqa: E501
- Returns
The static_timesteps of this SingleStepPseudoTimeStepping. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SingleStepPseudoTimeStepping. # noqa: E501
Schema name: SingleStepPseudoTimeStepping # noqa: E501
- Returns
The type of this SingleStepPseudoTimeStepping. # noqa: E501
- Return type
str
simscale_sdk.models.sliding_contact module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.sliding_contact.SlidingContact(type='SLIDING_CONTACT', name=None, enable_heat_transfer=None, position_tolerance=None, master_topological_reference=None, slave_topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'enable_heat_transfer': 'enableHeatTransfer', 'master_topological_reference': 'masterTopologicalReference', 'name': 'name', 'position_tolerance': 'positionTolerance', 'slave_topological_reference': 'slaveTopologicalReference', 'type': 'type'}¶
- property enable_heat_transfer¶
Gets the enable_heat_transfer of this SlidingContact. # noqa: E501
- Returns
The enable_heat_transfer of this SlidingContact. # noqa: E501
- Return type
str
- property master_topological_reference¶
Gets the master_topological_reference of this SlidingContact. # noqa: E501
- Returns
The master_topological_reference of this SlidingContact. # noqa: E501
- Return type
- property name¶
Gets the name of this SlidingContact. # noqa: E501
- Returns
The name of this SlidingContact. # noqa: E501
- Return type
str
- openapi_types = {'enable_heat_transfer': 'str', 'master_topological_reference': 'TopologicalReference', 'name': 'str', 'position_tolerance': 'OneOfSlidingContactPositionTolerance', 'slave_topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property position_tolerance¶
Gets the position_tolerance of this SlidingContact. # noqa: E501
- Returns
The position_tolerance of this SlidingContact. # noqa: E501
- Return type
OneOfSlidingContactPositionTolerance
- property slave_topological_reference¶
Gets the slave_topological_reference of this SlidingContact. # noqa: E501
- Returns
The slave_topological_reference of this SlidingContact. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SlidingContact. # noqa: E501
Schema name: SlidingContact # noqa: E501
- Returns
The type of this SlidingContact. # noqa: E501
- Return type
str
simscale_sdk.models.slip_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.slip_vbc.SlipVBC(type='SLIP', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SlipVBC. # noqa: E501
Schema name: SlipVBC # noqa: E501
- Returns
The type of this SlipVBC. # noqa: E501
- Return type
str
simscale_sdk.models.smooth_les_delta module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.smooth_les_delta.SmoothLesDelta(type='SMOOTH', delta_coefficient=None, max_delta_ratio=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'delta_coefficient': 'deltaCoefficient', 'max_delta_ratio': 'maxDeltaRatio', 'type': 'type'}¶
- property delta_coefficient¶
Gets the delta_coefficient of this SmoothLesDelta. # noqa: E501
- Returns
The delta_coefficient of this SmoothLesDelta. # noqa: E501
- Return type
- property max_delta_ratio¶
Gets the max_delta_ratio of this SmoothLesDelta. # noqa: E501
- Returns
The max_delta_ratio of this SmoothLesDelta. # noqa: E501
- Return type
float
- openapi_types = {'delta_coefficient': 'CubeRootVolLesDelta', 'max_delta_ratio': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SmoothLesDelta. # noqa: E501
Schema name: SmoothLesDelta # noqa: E501
- Returns
The type of this SmoothLesDelta. # noqa: E501
- Return type
str
simscale_sdk.models.smooth_solver module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.smooth_solver.SmoothSolver(type='SMOOTH', absolute_tolerance=None, relative_tolerance=None, smoother=None, num_sweeps=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property absolute_tolerance¶
Gets the absolute_tolerance of this SmoothSolver. # noqa: E501
<p>Define the absolute tolerance for the residual. The convergence process will be stopped as soon as the residual falls below the absolute tolerance.</p> # noqa: E501
- Returns
The absolute_tolerance of this SmoothSolver. # noqa: E501
- Return type
float
- attribute_map = {'absolute_tolerance': 'absoluteTolerance', 'num_sweeps': 'numSweeps', 'relative_tolerance': 'relativeTolerance', 'smoother': 'smoother', 'type': 'type'}¶
- property num_sweeps¶
Gets the num_sweeps of this SmoothSolver. # noqa: E501
<p>Define the numbers of sweeps.</p> # noqa: E501
- Returns
The num_sweeps of this SmoothSolver. # noqa: E501
- Return type
int
- openapi_types = {'absolute_tolerance': 'float', 'num_sweeps': 'int', 'relative_tolerance': 'float', 'smoother': 'str', 'type': 'str'}¶
- property relative_tolerance¶
Gets the relative_tolerance of this SmoothSolver. # noqa: E501
<p>Choose the relative tolerance for the residual. The convergence process will be stopped as soon as the ratio of current to initial residual falls below the relative tolerance.</p> # noqa: E501
- Returns
The relative_tolerance of this SmoothSolver. # noqa: E501
- Return type
float
- property smoother¶
Gets the smoother of this SmoothSolver. # noqa: E501
<p>Choose a smoother for your solver.</p> # noqa: E501
- Returns
The smoother of this SmoothSolver. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SmoothSolver. # noqa: E501
Schema name: SmoothSolver # noqa: E501
- Returns
The type of this SmoothSolver. # noqa: E501
- Return type
str
simscale_sdk.models.snap_controls module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.snap_controls.SnapControls(mesh_to_geometry_conformation_iterations=None, tolerance=None, solver_iterations=None, relax_iterations=None, max_mex_conformation_iterations=None, implicit_feature_snap=None, explicit_feature_snap=None, detect_features_between_multiple_surfaces=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'detect_features_between_multiple_surfaces': 'detectFeaturesBetweenMultipleSurfaces', 'explicit_feature_snap': 'explicitFeatureSnap', 'implicit_feature_snap': 'implicitFeatureSnap', 'max_mex_conformation_iterations': 'maxMexConformationIterations', 'mesh_to_geometry_conformation_iterations': 'meshToGeometryConformationIterations', 'relax_iterations': 'relaxIterations', 'solver_iterations': 'solverIterations', 'tolerance': 'tolerance'}¶
- property detect_features_between_multiple_surfaces¶
Gets the detect_features_between_multiple_surfaces of this SnapControls. # noqa: E501
<p>Also detect features between multiple surfaces. This is relevant when you want to create a mesh with multiple regions - used for example in the conjugate heat transfer solver. Needs ‘Use feature refinement for snapping’ turned on!</p> # noqa: E501
- Returns
The detect_features_between_multiple_surfaces of this SnapControls. # noqa: E501
- Return type
bool
- property explicit_feature_snap¶
Gets the explicit_feature_snap of this SnapControls. # noqa: E501
<p>Use the explicitly given feature refinements for feature snapping. An explicit feature refinement can be added under ‘Mesh refinement’. Specifying a feature refinement results in sharp mesh edges even with a refinement level of zero.</p> # noqa: E501
- Returns
The explicit_feature_snap of this SnapControls. # noqa: E501
- Return type
bool
- property implicit_feature_snap¶
Gets the implicit_feature_snap of this SnapControls. # noqa: E501
<p>Activating this makes the snapping algorithm detecting geometrical features by sampling the surface. This might be time-consuming. The other option is to create a feature refinement which also enables feature snapping.</p> # noqa: E501
- Returns
The implicit_feature_snap of this SnapControls. # noqa: E501
- Return type
bool
- property max_mex_conformation_iterations¶
Gets the max_mex_conformation_iterations of this SnapControls. # noqa: E501
<p>This parameter defines the max number of iterations done to ensure that the mesh conforms to the geometry.</p> # noqa: E501
- Returns
The max_mex_conformation_iterations of this SnapControls. # noqa: E501
- Return type
int
- property mesh_to_geometry_conformation_iterations¶
Gets the mesh_to_geometry_conformation_iterations of this SnapControls. # noqa: E501
<p>Define the max number of iterations to ensure that the mesh conforms to the geometry. Higher values lead to a better conforming mesh.</p> # noqa: E501
- Returns
The mesh_to_geometry_conformation_iterations of this SnapControls. # noqa: E501
- Return type
int
- openapi_types = {'detect_features_between_multiple_surfaces': 'bool', 'explicit_feature_snap': 'bool', 'implicit_feature_snap': 'bool', 'max_mex_conformation_iterations': 'int', 'mesh_to_geometry_conformation_iterations': 'int', 'relax_iterations': 'int', 'solver_iterations': 'int', 'tolerance': 'float'}¶
- property relax_iterations¶
Gets the relax_iterations of this SnapControls. # noqa: E501
<p>This parameter defines the max number of iterations to remove bad mesh points (see documentation).</p> # noqa: E501
- Returns
The relax_iterations of this SnapControls. # noqa: E501
- Return type
int
- property solver_iterations¶
Gets the solver_iterations of this SnapControls. # noqa: E501
<p>This parameter defines the number of displacement relaxation iterations during the meshing process. Higher values lead to enhanced mesh quality but increase the computing time.</p> # noqa: E501
- Returns
The solver_iterations of this SnapControls. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property tolerance¶
Gets the tolerance of this SnapControls. # noqa: E501
<p>This parameter describes a distance (relative to the local maximum mesh edge length) within which the algorithm looks for a geometry point to snap the mesh to. Higher values lead to better snapping but are costlier.</p> # noqa: E501
- Returns
The tolerance of this SnapControls. # noqa: E501
- Return type
float
simscale_sdk.models.snapshot_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.snapshot_result_control.SnapshotResultControl(type='SNAPSHOT', export_fluid=None, export_surface=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'export_fluid': 'exportFluid', 'export_surface': 'exportSurface', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property export_fluid¶
Gets the export_fluid of this SnapshotResultControl. # noqa: E501
When this switch is activated, simulation data of the flow-field enclosed in the assignments will be exported # noqa: E501
- Returns
The export_fluid of this SnapshotResultControl. # noqa: E501
- Return type
bool
- property export_surface¶
Gets the export_surface of this SnapshotResultControl. # noqa: E501
When this switch is activated, simulation data on all surfaces enclosed in the assignments will be exported # noqa: E501
- Returns
The export_surface of this SnapshotResultControl. # noqa: E501
- Return type
bool
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SnapshotResultControl. # noqa: E501
- Returns
The geometry_primitive_uuids of this SnapshotResultControl. # noqa: E501
- Return type
list[str]
- openapi_types = {'export_fluid': 'bool', 'export_surface': 'bool', 'geometry_primitive_uuids': 'list[str]', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SnapshotResultControl. # noqa: E501
- Returns
The topological_reference of this SnapshotResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this SnapshotResultControl. # noqa: E501
Schema name: SnapshotResultControl # noqa: E501
- Returns
The type of this SnapshotResultControl. # noqa: E501
- Return type
str
simscale_sdk.models.solar_calculator module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solar_calculator.SolarCalculator(sun_direction=None, solar_load=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'solar_load': 'solarLoad', 'sun_direction': 'sunDirection'}¶
- openapi_types = {'solar_load': 'OneOfSolarCalculatorSolarLoad', 'sun_direction': 'OneOfSolarCalculatorSunDirection'}¶
- property solar_load¶
Gets the solar_load of this SolarCalculator. # noqa: E501
- Returns
The solar_load of this SolarCalculator. # noqa: E501
- Return type
OneOfSolarCalculatorSolarLoad
- property sun_direction¶
Gets the sun_direction of this SolarCalculator. # noqa: E501
- Returns
The sun_direction of this SolarCalculator. # noqa: E501
- Return type
OneOfSolarCalculatorSunDirection
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.solid_compressible_material module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_compressible_material.SolidCompressibleMaterial(name=None, specie=None, transport=None, emissivity=None, topological_reference=None, built_in_material=None, material_library_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'built_in_material': 'builtInMaterial', 'emissivity': 'emissivity', 'material_library_reference': 'materialLibraryReference', 'name': 'name', 'specie': 'specie', 'topological_reference': 'topologicalReference', 'transport': 'transport'}¶
- property built_in_material¶
Gets the built_in_material of this SolidCompressibleMaterial. # noqa: E501
- Returns
The built_in_material of this SolidCompressibleMaterial. # noqa: E501
- Return type
str
- property emissivity¶
Gets the emissivity of this SolidCompressibleMaterial. # noqa: E501
- Returns
The emissivity of this SolidCompressibleMaterial. # noqa: E501
- Return type
float
- property material_library_reference¶
Gets the material_library_reference of this SolidCompressibleMaterial. # noqa: E501
- Returns
The material_library_reference of this SolidCompressibleMaterial. # noqa: E501
- Return type
- property name¶
Gets the name of this SolidCompressibleMaterial. # noqa: E501
- Returns
The name of this SolidCompressibleMaterial. # noqa: E501
- Return type
str
- openapi_types = {'built_in_material': 'str', 'emissivity': 'float', 'material_library_reference': 'MaterialLibraryReference', 'name': 'str', 'specie': 'SpecieDefault', 'topological_reference': 'TopologicalReference', 'transport': 'OneOfSolidCompressibleMaterialTransport'}¶
- property specie¶
Gets the specie of this SolidCompressibleMaterial. # noqa: E501
- Returns
The specie of this SolidCompressibleMaterial. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SolidCompressibleMaterial. # noqa: E501
- Returns
The topological_reference of this SolidCompressibleMaterial. # noqa: E501
- Return type
- property transport¶
Gets the transport of this SolidCompressibleMaterial. # noqa: E501
- Returns
The transport of this SolidCompressibleMaterial. # noqa: E501
- Return type
OneOfSolidCompressibleMaterialTransport
simscale_sdk.models.solid_element_technology module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_element_technology.SolidElementTechnology(element_technology3_d=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'element_technology3_d': 'elementTechnology3D'}¶
- property element_technology3_d¶
Gets the element_technology3_d of this SolidElementTechnology. # noqa: E501
- Returns
The element_technology3_d of this SolidElementTechnology. # noqa: E501
- Return type
- openapi_types = {'element_technology3_d': 'ElementTechnology'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.solid_initial_conditions module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_initial_conditions.SolidInitialConditions(displacement=None, velocity=None, acceleration=None, stress=None, temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property acceleration¶
Gets the acceleration of this SolidInitialConditions. # noqa: E501
- Returns
The acceleration of this SolidInitialConditions. # noqa: E501
- Return type
DimensionalVectorFunctionInitialConditionWithDomainsAcceleration
- attribute_map = {'acceleration': 'acceleration', 'displacement': 'displacement', 'stress': 'stress', 'temperature': 'temperature', 'velocity': 'velocity'}¶
- property displacement¶
Gets the displacement of this SolidInitialConditions. # noqa: E501
- Returns
The displacement of this SolidInitialConditions. # noqa: E501
- Return type
- openapi_types = {'acceleration': 'DimensionalVectorFunctionInitialConditionWithDomainsAcceleration', 'displacement': 'DimensionalVectorFunctionInitialConditionWithDomainsLength', 'stress': 'StressInitialConditionDomains', 'temperature': 'DimensionalFunctionInitialConditionDomainsTemperature', 'velocity': 'DimensionalVectorFunctionInitialConditionWithDomainsSpeed'}¶
- property stress¶
Gets the stress of this SolidInitialConditions. # noqa: E501
- Returns
The stress of this SolidInitialConditions. # noqa: E501
- Return type
- property temperature¶
Gets the temperature of this SolidInitialConditions. # noqa: E501
- Returns
The temperature of this SolidInitialConditions. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property velocity¶
Gets the velocity of this SolidInitialConditions. # noqa: E501
- Returns
The velocity of this SolidInitialConditions. # noqa: E501
- Return type
simscale_sdk.models.solid_material module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_material.SolidMaterial(name=None, material_behavior=None, density=None, expansion=None, conductivity=None, specific_heat=None, topological_reference=None, built_in_material=None, material_library_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'built_in_material': 'builtInMaterial', 'conductivity': 'conductivity', 'density': 'density', 'expansion': 'expansion', 'material_behavior': 'materialBehavior', 'material_library_reference': 'materialLibraryReference', 'name': 'name', 'specific_heat': 'specificHeat', 'topological_reference': 'topologicalReference'}¶
- property built_in_material¶
Gets the built_in_material of this SolidMaterial. # noqa: E501
- Returns
The built_in_material of this SolidMaterial. # noqa: E501
- Return type
str
- property conductivity¶
Gets the conductivity of this SolidMaterial. # noqa: E501
- Returns
The conductivity of this SolidMaterial. # noqa: E501
- Return type
OneOfSolidMaterialConductivity
- property density¶
Gets the density of this SolidMaterial. # noqa: E501
- Returns
The density of this SolidMaterial. # noqa: E501
- Return type
- property expansion¶
Gets the expansion of this SolidMaterial. # noqa: E501
- Returns
The expansion of this SolidMaterial. # noqa: E501
- Return type
- property material_behavior¶
Gets the material_behavior of this SolidMaterial. # noqa: E501
- Returns
The material_behavior of this SolidMaterial. # noqa: E501
- Return type
OneOfSolidMaterialMaterialBehavior
- property material_library_reference¶
Gets the material_library_reference of this SolidMaterial. # noqa: E501
- Returns
The material_library_reference of this SolidMaterial. # noqa: E501
- Return type
- property name¶
Gets the name of this SolidMaterial. # noqa: E501
- Returns
The name of this SolidMaterial. # noqa: E501
- Return type
str
- openapi_types = {'built_in_material': 'str', 'conductivity': 'OneOfSolidMaterialConductivity', 'density': 'DimensionalFunctionDensity', 'expansion': 'IsotropicExpansion', 'material_behavior': 'OneOfSolidMaterialMaterialBehavior', 'material_library_reference': 'MaterialLibraryReference', 'name': 'str', 'specific_heat': 'DimensionalFunctionSpecificHeat', 'topological_reference': 'TopologicalReference'}¶
- property specific_heat¶
Gets the specific_heat of this SolidMaterial. # noqa: E501
- Returns
The specific_heat of this SolidMaterial. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SolidMaterial. # noqa: E501
- Returns
The topological_reference of this SolidMaterial. # noqa: E501
- Return type
simscale_sdk.models.solid_model module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_model.SolidModel(geometric_behavior=None, magnitude=None, e=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'e': 'e', 'geometric_behavior': 'geometricBehavior', 'magnitude': 'magnitude'}¶
- property e¶
Gets the e of this SolidModel. # noqa: E501
- Returns
The e of this SolidModel. # noqa: E501
- Return type
- property geometric_behavior¶
Gets the geometric_behavior of this SolidModel. # noqa: E501
- Returns
The geometric_behavior of this SolidModel. # noqa: E501
- Return type
str
- property magnitude¶
Gets the magnitude of this SolidModel. # noqa: E501
- Returns
The magnitude of this SolidModel. # noqa: E501
- Return type
- openapi_types = {'e': 'DimensionalVectorLength', 'geometric_behavior': 'str', 'magnitude': 'DimensionalFunctionAcceleration'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.solid_numerics module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_numerics.SolidNumerics(solver=None, solve_model=None, eigen_solver=None, calculate_frequency=None, eigen_mode=None, mechanical_time_integration_type=None, mechanical_resolution_type=None, mechanical_line_search=None, thermal_time_integration_type=None, thermal_resolution_type=None, thermal_line_search=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'calculate_frequency': 'calculateFrequency', 'eigen_mode': 'eigenMode', 'eigen_solver': 'eigenSolver', 'mechanical_line_search': 'mechanicalLineSearch', 'mechanical_resolution_type': 'mechanicalResolutionType', 'mechanical_time_integration_type': 'mechanicalTimeIntegrationType', 'solve_model': 'solveModel', 'solver': 'solver', 'thermal_line_search': 'thermalLineSearch', 'thermal_resolution_type': 'thermalResolutionType', 'thermal_time_integration_type': 'thermalTimeIntegrationType'}¶
- property calculate_frequency¶
Gets the calculate_frequency of this SolidNumerics. # noqa: E501
- Returns
The calculate_frequency of this SolidNumerics. # noqa: E501
- Return type
- property eigen_mode¶
Gets the eigen_mode of this SolidNumerics. # noqa: E501
- Returns
The eigen_mode of this SolidNumerics. # noqa: E501
- Return type
- property eigen_solver¶
Gets the eigen_solver of this SolidNumerics. # noqa: E501
- Returns
The eigen_solver of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsEigenSolver
- property mechanical_line_search¶
Gets the mechanical_line_search of this SolidNumerics. # noqa: E501
- Returns
The mechanical_line_search of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsMechanicalLineSearch
- property mechanical_resolution_type¶
Gets the mechanical_resolution_type of this SolidNumerics. # noqa: E501
- Returns
The mechanical_resolution_type of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsMechanicalResolutionType
- property mechanical_time_integration_type¶
Gets the mechanical_time_integration_type of this SolidNumerics. # noqa: E501
- Returns
The mechanical_time_integration_type of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsMechanicalTimeIntegrationType
- openapi_types = {'calculate_frequency': 'CalculateFrequency', 'eigen_mode': 'EigenModeVerification', 'eigen_solver': 'OneOfSolidNumericsEigenSolver', 'mechanical_line_search': 'OneOfSolidNumericsMechanicalLineSearch', 'mechanical_resolution_type': 'OneOfSolidNumericsMechanicalResolutionType', 'mechanical_time_integration_type': 'OneOfSolidNumericsMechanicalTimeIntegrationType', 'solve_model': 'object', 'solver': 'OneOfSolidNumericsSolver', 'thermal_line_search': 'OneOfSolidNumericsThermalLineSearch', 'thermal_resolution_type': 'OneOfSolidNumericsThermalResolutionType', 'thermal_time_integration_type': 'ThetaMethodTimeIntegrationType'}¶
- property solve_model¶
Gets the solve_model of this SolidNumerics. # noqa: E501
- Returns
The solve_model of this SolidNumerics. # noqa: E501
- Return type
object
- property solver¶
Gets the solver of this SolidNumerics. # noqa: E501
- Returns
The solver of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsSolver
- property thermal_line_search¶
Gets the thermal_line_search of this SolidNumerics. # noqa: E501
- Returns
The thermal_line_search of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsThermalLineSearch
- property thermal_resolution_type¶
Gets the thermal_resolution_type of this SolidNumerics. # noqa: E501
- Returns
The thermal_resolution_type of this SolidNumerics. # noqa: E501
- Return type
OneOfSolidNumericsThermalResolutionType
- property thermal_time_integration_type¶
Gets the thermal_time_integration_type of this SolidNumerics. # noqa: E501
- Returns
The thermal_time_integration_type of this SolidNumerics. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.solid_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_result_control.SolidResultControl(solution_fields=None, edge_calculation=None, area_calculation=None, volume_calculation=None, point_data=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property area_calculation¶
Gets the area_calculation of this SolidResultControl. # noqa: E501
- Returns
The area_calculation of this SolidResultControl. # noqa: E501
- Return type
list[OneOfSolidResultControlAreaCalculation]
- attribute_map = {'area_calculation': 'areaCalculation', 'edge_calculation': 'edgeCalculation', 'point_data': 'pointData', 'solution_fields': 'solutionFields', 'volume_calculation': 'volumeCalculation'}¶
- property edge_calculation¶
Gets the edge_calculation of this SolidResultControl. # noqa: E501
- Returns
The edge_calculation of this SolidResultControl. # noqa: E501
- Return type
list[OneOfSolidResultControlEdgeCalculation]
- openapi_types = {'area_calculation': 'list[OneOfSolidResultControlAreaCalculation]', 'edge_calculation': 'list[OneOfSolidResultControlEdgeCalculation]', 'point_data': 'list[OneOfSolidResultControlPointData]', 'solution_fields': 'list[OneOfSolidResultControlSolutionFields]', 'volume_calculation': 'list[OneOfSolidResultControlVolumeCalculation]'}¶
- property point_data¶
Gets the point_data of this SolidResultControl. # noqa: E501
- Returns
The point_data of this SolidResultControl. # noqa: E501
- Return type
list[OneOfSolidResultControlPointData]
- property solution_fields¶
Gets the solution_fields of this SolidResultControl. # noqa: E501
- Returns
The solution_fields of this SolidResultControl. # noqa: E501
- Return type
list[OneOfSolidResultControlSolutionFields]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property volume_calculation¶
Gets the volume_calculation of this SolidResultControl. # noqa: E501
- Returns
The volume_calculation of this SolidResultControl. # noqa: E501
- Return type
list[OneOfSolidResultControlVolumeCalculation]
simscale_sdk.models.solid_simulation_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.solid_simulation_control.SolidSimulationControl(timestep_definition=None, pseudo_time_stepping=None, write_control_definition=None, excitation_frequencies=None, eigenfrequency_scope=None, processors=None, max_run_time=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'eigenfrequency_scope': 'eigenfrequencyScope', 'excitation_frequencies': 'excitationFrequencies', 'max_run_time': 'maxRunTime', 'processors': 'processors', 'pseudo_time_stepping': 'pseudoTimeStepping', 'timestep_definition': 'timestepDefinition', 'write_control_definition': 'writeControlDefinition'}¶
- property eigenfrequency_scope¶
Gets the eigenfrequency_scope of this SolidSimulationControl. # noqa: E501
- Returns
The eigenfrequency_scope of this SolidSimulationControl. # noqa: E501
- Return type
OneOfSolidSimulationControlEigenfrequencyScope
- property excitation_frequencies¶
Gets the excitation_frequencies of this SolidSimulationControl. # noqa: E501
- Returns
The excitation_frequencies of this SolidSimulationControl. # noqa: E501
- Return type
OneOfSolidSimulationControlExcitationFrequencies
- property max_run_time¶
Gets the max_run_time of this SolidSimulationControl. # noqa: E501
- Returns
The max_run_time of this SolidSimulationControl. # noqa: E501
- Return type
- openapi_types = {'eigenfrequency_scope': 'OneOfSolidSimulationControlEigenfrequencyScope', 'excitation_frequencies': 'OneOfSolidSimulationControlExcitationFrequencies', 'max_run_time': 'DimensionalTime', 'processors': 'ComputingCore', 'pseudo_time_stepping': 'OneOfSolidSimulationControlPseudoTimeStepping', 'timestep_definition': 'OneOfSolidSimulationControlTimestepDefinition', 'write_control_definition': 'OneOfSolidSimulationControlWriteControlDefinition'}¶
- property processors¶
Gets the processors of this SolidSimulationControl. # noqa: E501
- Returns
The processors of this SolidSimulationControl. # noqa: E501
- Return type
- property pseudo_time_stepping¶
Gets the pseudo_time_stepping of this SolidSimulationControl. # noqa: E501
- Returns
The pseudo_time_stepping of this SolidSimulationControl. # noqa: E501
- Return type
OneOfSolidSimulationControlPseudoTimeStepping
- property timestep_definition¶
Gets the timestep_definition of this SolidSimulationControl. # noqa: E501
- Returns
The timestep_definition of this SolidSimulationControl. # noqa: E501
- Return type
OneOfSolidSimulationControlTimestepDefinition
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property write_control_definition¶
Gets the write_control_definition of this SolidSimulationControl. # noqa: E501
- Returns
The write_control_definition of this SolidSimulationControl. # noqa: E501
- Return type
OneOfSolidSimulationControlWriteControlDefinition
simscale_sdk.models.sor_preconditioner module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.sor_preconditioner.SorPreconditioner(type='SOR', renumbering_method=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'renumbering_method': 'renumberingMethod', 'type': 'type'}¶
- openapi_types = {'renumbering_method': 'str', 'type': 'str'}¶
- property renumbering_method¶
Gets the renumbering_method of this SorPreconditioner. # noqa: E501
Choose the renumbering method for the system matrix entries:<ul><li><p><b>RCMK</b> uses the algorithm of <i>Reverse Cuthill-MacKee</i> for the renumbering. It often effectively reduces the matrig storage space and the matrix factorization time.</p></ul><ul><li><p>When <b>inactive</b> is selected no renumbering is done. This option should only be chosen for testing purposes.</p></ul> # noqa: E501
- Returns
The renumbering_method of this SorPreconditioner. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SorPreconditioner. # noqa: E501
Schema name: SorPreconditioner # noqa: E501
- Returns
The type of this SorPreconditioner. # noqa: E501
- Return type
str
simscale_sdk.models.specie_default module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.specie_default.SpecieDefault(type='SPECIE', amount_of_substance=None, molar_weight=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property amount_of_substance¶
Gets the amount_of_substance of this SpecieDefault. # noqa: E501
- Returns
The amount_of_substance of this SpecieDefault. # noqa: E501
- Return type
- attribute_map = {'amount_of_substance': 'amountOfSubstance', 'molar_weight': 'molarWeight', 'type': 'type'}¶
- property molar_weight¶
Gets the molar_weight of this SpecieDefault. # noqa: E501
- Returns
The molar_weight of this SpecieDefault. # noqa: E501
- Return type
- openapi_types = {'amount_of_substance': 'DimensionalAmountOfSubstance', 'molar_weight': 'DimensionalMolarMass', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SpecieDefault. # noqa: E501
<p><b>Specie:</b> defines the molecular composition of the fluid material. Currently a single specie is available.</p> Schema name: SpecieDefault # noqa: E501
- Returns
The type of this SpecieDefault. # noqa: E501
- Return type
str
simscale_sdk.models.specific_conductance_interface_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.specific_conductance_interface_thermal.SpecificConductanceInterfaceThermal(type='SPECIFIC_CONDUCTANCE', contact_conductance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_conductance': 'contactConductance', 'type': 'type'}¶
- property contact_conductance¶
Gets the contact_conductance of this SpecificConductanceInterfaceThermal. # noqa: E501
- Returns
The contact_conductance of this SpecificConductanceInterfaceThermal. # noqa: E501
- Return type
- openapi_types = {'contact_conductance': 'DimensionalThermalTransmittance', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SpecificConductanceInterfaceThermal. # noqa: E501
Schema name: SpecificConductanceInterfaceThermal # noqa: E501
- Returns
The type of this SpecificConductanceInterfaceThermal. # noqa: E501
- Return type
str
simscale_sdk.models.specific_conductance_wall_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.specific_conductance_wall_thermal.SpecificConductanceWallThermal(type='SPECIFIC_CONDUCTANCE', contact_conductance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_conductance': 'contactConductance', 'type': 'type'}¶
- property contact_conductance¶
Gets the contact_conductance of this SpecificConductanceWallThermal. # noqa: E501
- Returns
The contact_conductance of this SpecificConductanceWallThermal. # noqa: E501
- Return type
- openapi_types = {'contact_conductance': 'DimensionalThermalTransmittance', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SpecificConductanceWallThermal. # noqa: E501
Schema name: SpecificConductanceWallThermal # noqa: E501
- Returns
The type of this SpecificConductanceWallThermal. # noqa: E501
- Return type
str
simscale_sdk.models.specific_passive_scalar_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.specific_passive_scalar_source.SpecificPassiveScalarSource(type='SPECIFIC', name=None, passive_scalar_variable=None, flux=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'flux': 'flux', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'passive_scalar_variable': 'passiveScalarVariable', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property flux¶
Gets the flux of this SpecificPassiveScalarSource. # noqa: E501
- Returns
The flux of this SpecificPassiveScalarSource. # noqa: E501
- Return type
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SpecificPassiveScalarSource. # noqa: E501
- Returns
The geometry_primitive_uuids of this SpecificPassiveScalarSource. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SpecificPassiveScalarSource. # noqa: E501
- Returns
The name of this SpecificPassiveScalarSource. # noqa: E501
- Return type
str
- openapi_types = {'flux': 'DimensionalVolumetricPassiveScalarSourceRate', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'passive_scalar_variable': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property passive_scalar_variable¶
Gets the passive_scalar_variable of this SpecificPassiveScalarSource. # noqa: E501
- Returns
The passive_scalar_variable of this SpecificPassiveScalarSource. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SpecificPassiveScalarSource. # noqa: E501
- Returns
The topological_reference of this SpecificPassiveScalarSource. # noqa: E501
- Return type
- property type¶
Gets the type of this SpecificPassiveScalarSource. # noqa: E501
Schema name: SpecificPassiveScalarSource # noqa: E501
- Returns
The type of this SpecificPassiveScalarSource. # noqa: E501
- Return type
str
simscale_sdk.models.specific_power_source module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.specific_power_source.SpecificPowerSource(type='SPECIFIC_V23', name=None, heat_flux=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'heat_flux': 'heatFlux', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SpecificPowerSource. # noqa: E501
- Returns
The geometry_primitive_uuids of this SpecificPowerSource. # noqa: E501
- Return type
list[str]
- property heat_flux¶
Gets the heat_flux of this SpecificPowerSource. # noqa: E501
- Returns
The heat_flux of this SpecificPowerSource. # noqa: E501
- Return type
- property name¶
Gets the name of this SpecificPowerSource. # noqa: E501
- Returns
The name of this SpecificPowerSource. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'heat_flux': 'DimensionalFunctionVolumetricPower', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SpecificPowerSource. # noqa: E501
- Returns
The topological_reference of this SpecificPowerSource. # noqa: E501
- Return type
- property type¶
Gets the type of this SpecificPowerSource. # noqa: E501
<i>Power sources</i> can be used to simulate heat generation from a volume. Two types are available:<br><li><b>Absolute</b></li>: Used when total power emitted by the assigned volume is known.<li><b>Specific</b></li>: Used when power density of the assigned volume is known. <a href=’https://www.simscale.com/docs/simulation-setup/advanced-concepts/power-sources/’ target=’_blank’>Learn more</a>. Schema name: SpecificPowerSource # noqa: E501
- Returns
The type of this SpecificPowerSource. # noqa: E501
- Return type
str
simscale_sdk.models.sphere module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.sphere.Sphere(type='SPHERE', id=None, name=None, center=None, radius=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center': 'center', 'id': 'id', 'name': 'name', 'radius': 'radius', 'type': 'type'}¶
- property center¶
Gets the center of this Sphere. # noqa: E501
- Returns
The center of this Sphere. # noqa: E501
- Return type
- property id¶
Gets the id of this Sphere. # noqa: E501
- Returns
The id of this Sphere. # noqa: E501
- Return type
str
- property name¶
Gets the name of this Sphere. # noqa: E501
- Returns
The name of this Sphere. # noqa: E501
- Return type
str
- openapi_types = {'center': 'DimensionalVectorLength', 'id': 'str', 'name': 'str', 'radius': 'DimensionalLength', 'type': 'str'}¶
- property radius¶
Gets the radius of this Sphere. # noqa: E501
- Returns
The radius of this Sphere. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Sphere. # noqa: E501
Schema name: Sphere # noqa: E501
- Returns
The type of this Sphere. # noqa: E501
- Return type
str
simscale_sdk.models.spheres_visualization_style module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.spheres_visualization_style.SpheresVisualizationStyle(representation='SPHERES', num_pulses=15, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'num_pulses': 'numPulses', 'representation': 'representation'}¶
- property num_pulses¶
Gets the num_pulses of this SpheresVisualizationStyle. # noqa: E501
This value specifies how many pulses there should be in the model. # noqa: E501
- Returns
The num_pulses of this SpheresVisualizationStyle. # noqa: E501
- Return type
int
- openapi_types = {'num_pulses': 'int', 'representation': 'str'}¶
- property representation¶
Gets the representation of this SpheresVisualizationStyle. # noqa: E501
The representation to use for particle traces. # noqa: E501
- Returns
The representation of this SpheresVisualizationStyle. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.star_thermal_resistance_network module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.star_thermal_resistance_network.StarThermalResistanceNetwork(type='STAR_NETWORK', name=None, resistance_top=None, resistance_bottom=None, resistance_sides=None, resistance_interface=None, network_power=None, emissivity=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'emissivity': 'emissivity', 'name': 'name', 'network_power': 'networkPower', 'resistance_bottom': 'resistanceBottom', 'resistance_interface': 'resistanceInterface', 'resistance_sides': 'resistanceSides', 'resistance_top': 'resistanceTop', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property emissivity¶
Gets the emissivity of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The emissivity of this StarThermalResistanceNetwork. # noqa: E501
- Return type
float
- property name¶
Gets the name of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The name of this StarThermalResistanceNetwork. # noqa: E501
- Return type
str
- property network_power¶
Gets the network_power of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The network_power of this StarThermalResistanceNetwork. # noqa: E501
- Return type
- openapi_types = {'emissivity': 'float', 'name': 'str', 'network_power': 'DimensionalPower', 'resistance_bottom': 'DimensionalContactResistance', 'resistance_interface': 'DimensionalContactResistance', 'resistance_sides': 'DimensionalContactResistance', 'resistance_top': 'DimensionalContactResistance', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property resistance_bottom¶
Gets the resistance_bottom of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The resistance_bottom of this StarThermalResistanceNetwork. # noqa: E501
- Return type
- property resistance_interface¶
Gets the resistance_interface of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The resistance_interface of this StarThermalResistanceNetwork. # noqa: E501
- Return type
- property resistance_sides¶
Gets the resistance_sides of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The resistance_sides of this StarThermalResistanceNetwork. # noqa: E501
- Return type
- property resistance_top¶
Gets the resistance_top of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The resistance_top of this StarThermalResistanceNetwork. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this StarThermalResistanceNetwork. # noqa: E501
- Returns
The topological_reference of this StarThermalResistanceNetwork. # noqa: E501
- Return type
- property type¶
Gets the type of this StarThermalResistanceNetwork. # noqa: E501
<br>A <i>Thermal Resistance Network</i> can be used to approximate the effect of heat sources and heat transfer from that source to the surrounding domain without resolving the source geometry. Select the top face of the body you want to assign. <p>The models for <b>Thermal resistance network</b> are as follows:</p><ul><li><b>Star Network Resistance Model:</b> defines a thermal resistance network consisting out of a top, a board, a board to interface and four side resistances. A power source is assigned to the body.</li><li><b>Two resistor Model:</b> defines a thermal resistance network consisting out of a top, a board and a board to interface resistance. A power source is assigned to the body.</li></ul> <br> <a href=’https://www.simscale.com/docs/simulation-setup/advanced-concepts/thermal-resistance-networks/’ target=’_blank’>Learn more</a>. Schema name: StarThermalResistanceNetwork # noqa: E501
- Returns
The type of this StarThermalResistanceNetwork. # noqa: E501
- Return type
str
simscale_sdk.models.static_analysis module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.static_analysis.StaticAnalysis(type='STATIC_ANALYSIS', non_linear_analysis=None, connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'element_technology': 'elementTechnology', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'mesh_order': 'meshOrder', 'model': 'model', 'non_linear_analysis': 'nonLinearAnalysis', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this StaticAnalysis. # noqa: E501
- Returns
The boundary_conditions of this StaticAnalysis. # noqa: E501
- Return type
list[OneOfStaticAnalysisBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this StaticAnalysis. # noqa: E501
- Returns
The connection_groups of this StaticAnalysis. # noqa: E501
- Return type
list[OneOfStaticAnalysisConnectionGroups]
- property element_technology¶
Gets the element_technology of this StaticAnalysis. # noqa: E501
- Returns
The element_technology of this StaticAnalysis. # noqa: E501
- Return type
- property initial_conditions¶
Gets the initial_conditions of this StaticAnalysis. # noqa: E501
- Returns
The initial_conditions of this StaticAnalysis. # noqa: E501
- Return type
- property materials¶
Gets the materials of this StaticAnalysis. # noqa: E501
- Returns
The materials of this StaticAnalysis. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this StaticAnalysis. # noqa: E501
- Returns
The mesh_order of this StaticAnalysis. # noqa: E501
- Return type
str
- property model¶
Gets the model of this StaticAnalysis. # noqa: E501
- Returns
The model of this StaticAnalysis. # noqa: E501
- Return type
- property non_linear_analysis¶
Gets the non_linear_analysis of this StaticAnalysis. # noqa: E501
<p>Choose if your analysis should feature any kind of <b>nonlinearity</b> like <b>physical contacts, nonlinear materials</b> as hyperelasticity or plasticity or <b>large rotations</b> and <b>large deformations, temperature dependant material properties</b> or <b>temperature dependant boundary conditions</b>. For a <b>linear analysis</b> none of those nonlinearities are available.</p> # noqa: E501
- Returns
The non_linear_analysis of this StaticAnalysis. # noqa: E501
- Return type
bool
- property numerics¶
Gets the numerics of this StaticAnalysis. # noqa: E501
- Returns
The numerics of this StaticAnalysis. # noqa: E501
- Return type
- openapi_types = {'boundary_conditions': 'list[OneOfStaticAnalysisBoundaryConditions]', 'connection_groups': 'list[OneOfStaticAnalysisConnectionGroups]', 'element_technology': 'SolidElementTechnology', 'initial_conditions': 'SolidInitialConditions', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'model': 'SolidModel', 'non_linear_analysis': 'bool', 'numerics': 'SolidNumerics', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this StaticAnalysis. # noqa: E501
- Returns
The result_control of this StaticAnalysis. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this StaticAnalysis. # noqa: E501
- Returns
The simulation_control of this StaticAnalysis. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StaticAnalysis. # noqa: E501
Schema name: StaticAnalysis # noqa: E501
- Returns
The type of this StaticAnalysis. # noqa: E501
- Return type
str
simscale_sdk.models.static_pressure_pressure_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.static_pressure_pressure_type.StaticPressurePressureType(type='STATIC_PRESSURE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StaticPressurePressureType. # noqa: E501
Schema name: StaticPressurePressureType # noqa: E501
- Returns
The type of this StaticPressurePressureType. # noqa: E501
- Return type
str
simscale_sdk.models.stationary_time_dependency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.stationary_time_dependency.StationaryTimeDependency(type='STATIONARY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StationaryTimeDependency. # noqa: E501
Schema name: StationaryTimeDependency # noqa: E501
- Returns
The type of this StationaryTimeDependency. # noqa: E501
- Return type
str
simscale_sdk.models.statistical_averaging_result_control_v2 module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.statistical_averaging_result_control_v2.StatisticalAveragingResultControlV2(type='STATISTICAL_AVERAGING_V2', fraction_from_end=None, sampling_interval=None, export_fluid=None, export_surface=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'export_fluid': 'exportFluid', 'export_surface': 'exportSurface', 'fraction_from_end': 'fractionFromEnd', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'sampling_interval': 'samplingInterval', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property export_fluid¶
Gets the export_fluid of this StatisticalAveragingResultControlV2. # noqa: E501
When this switch is activated, simulation data of the flow-field enclosed in the assignments will be exported # noqa: E501
- Returns
The export_fluid of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
bool
- property export_surface¶
Gets the export_surface of this StatisticalAveragingResultControlV2. # noqa: E501
When this switch is activated, simulation data on all surfaces enclosed in the assignments will be exported # noqa: E501
- Returns
The export_surface of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
bool
- property fraction_from_end¶
Gets the fraction_from_end of this StatisticalAveragingResultControlV2. # noqa: E501
It defines the point in simulation where the result output data extraction starts. For instance, <i>Fraction from end</i> of 1 (100%) extracts all data from the beginning of the simulation while default 0.2 extracts 20% data from the end of the simulation. # noqa: E501
- Returns
The fraction_from_end of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
float
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this StatisticalAveragingResultControlV2. # noqa: E501
- Returns
The geometry_primitive_uuids of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
list[str]
- openapi_types = {'export_fluid': 'bool', 'export_surface': 'bool', 'fraction_from_end': 'float', 'geometry_primitive_uuids': 'list[str]', 'sampling_interval': 'OneOfStatisticalAveragingResultControlV2SamplingInterval', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property sampling_interval¶
Gets the sampling_interval of this StatisticalAveragingResultControlV2. # noqa: E501
- Returns
The sampling_interval of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
OneOfStatisticalAveragingResultControlV2SamplingInterval
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this StatisticalAveragingResultControlV2. # noqa: E501
- Returns
The topological_reference of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
- property type¶
Gets the type of this StatisticalAveragingResultControlV2. # noqa: E501
Schema name: StatisticalAveragingResultControlV2 # noqa: E501
- Returns
The type of this StatisticalAveragingResultControlV2. # noqa: E501
- Return type
str
simscale_sdk.models.status module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.status.Status(local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- CANCELED = 'CANCELED'¶
- FAILED = 'FAILED'¶
- FINISHED = 'FINISHED'¶
- QUEUED = 'QUEUED'¶
- READY = 'READY'¶
- RUNNING = 'RUNNING'¶
- allowable_values = ['READY', 'QUEUED', 'RUNNING', 'FINISHED', 'CANCELED', 'FAILED']¶
- Attributes:
- openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}¶
- openapi_types = {}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.steadystate_time_differentiation_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.steadystate_time_differentiation_scheme.SteadystateTimeDifferentiationScheme(type='STEADYSTATE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SteadystateTimeDifferentiationScheme. # noqa: E501
Schema name: SteadystateTimeDifferentiationScheme # noqa: E501
- Returns
The type of this SteadystateTimeDifferentiationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.stepping_list_pseudo_time_stepping module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.stepping_list_pseudo_time_stepping.SteppingListPseudoTimeStepping(type='STEPPING_LIST_V18', simulation_intervals=None, timestep_length=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'simulation_intervals': 'simulationIntervals', 'timestep_length': 'timestepLength', 'type': 'type'}¶
- openapi_types = {'simulation_intervals': 'DimensionalTime', 'timestep_length': 'RestrictedDimensionalFunctionTime', 'type': 'str'}¶
- property simulation_intervals¶
Gets the simulation_intervals of this SteppingListPseudoTimeStepping. # noqa: E501
- Returns
The simulation_intervals of this SteppingListPseudoTimeStepping. # noqa: E501
- Return type
- property timestep_length¶
Gets the timestep_length of this SteppingListPseudoTimeStepping. # noqa: E501
- Returns
The timestep_length of this SteppingListPseudoTimeStepping. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SteppingListPseudoTimeStepping. # noqa: E501
Schema name: SteppingListPseudoTimeStepping # noqa: E501
- Returns
The type of this SteppingListPseudoTimeStepping. # noqa: E501
- Return type
str
simscale_sdk.models.storage module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.storage.Storage(url=None, storage_id=None, expires_at=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'expires_at': 'expiresAt', 'storage_id': 'storageId', 'url': 'url'}¶
- property expires_at¶
Gets the expires_at of this Storage. # noqa: E501
The expiration time. # noqa: E501
- Returns
The expires_at of this Storage. # noqa: E501
- Return type
datetime
- openapi_types = {'expires_at': 'datetime', 'storage_id': 'str', 'url': 'str'}¶
- property storage_id¶
Gets the storage_id of this Storage. # noqa: E501
The storage ID. # noqa: E501
- Returns
The storage_id of this Storage. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property url¶
Gets the url of this Storage. # noqa: E501
The URL of the temporary storage location. # noqa: E501
- Returns
The url of this Storage. # noqa: E501
- Return type
str
simscale_sdk.models.strain_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.strain_field_selection.StrainFieldSelection(type='STRAIN', strain_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'strain_type': 'strainType', 'type': 'type'}¶
- openapi_types = {'strain_type': 'OneOfStrainFieldSelectionStrainType', 'type': 'str'}¶
- property strain_type¶
Gets the strain_type of this StrainFieldSelection. # noqa: E501
- Returns
The strain_type of this StrainFieldSelection. # noqa: E501
- Return type
OneOfStrainFieldSelectionStrainType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StrainFieldSelection. # noqa: E501
Schema name: StrainFieldSelection # noqa: E501
- Returns
The type of this StrainFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.strain_hardening_creep_formulation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.strain_hardening_creep_formulation.StrainHardeningCreepFormulation(type='STRAIN_HARDENING', a=None, n=None, m=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property a¶
Gets the a of this StrainHardeningCreepFormulation. # noqa: E501
- Returns
The a of this StrainHardeningCreepFormulation. # noqa: E501
- Return type
- attribute_map = {'a': 'a', 'm': 'm', 'n': 'n', 'type': 'type'}¶
- property m¶
Gets the m of this StrainHardeningCreepFormulation. # noqa: E501
<p>Define the parameter <b>m</b> of the Strain Hardening creep formulation: <ul><b>ε̇ = A*σ<sup>n</sup>*ε<sup>m</sup></b></ul></p> # noqa: E501
- Returns
The m of this StrainHardeningCreepFormulation. # noqa: E501
- Return type
float
- property n¶
Gets the n of this StrainHardeningCreepFormulation. # noqa: E501
<p>Define the parameter <b>n</b> of the Strain Hardening creep formulation: <ul><b>ε̇ = A*σ<sup>n</sup>*ε<sup>m</sup></b></ul></p> # noqa: E501
- Returns
The n of this StrainHardeningCreepFormulation. # noqa: E501
- Return type
float
- openapi_types = {'a': 'DimensionalStrainRate', 'm': 'float', 'n': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StrainHardeningCreepFormulation. # noqa: E501
<p>Define the Creep formulation. Two fundamental Creep law types are available: <ul><li><b>Power Law</b></li><b>ε̇ = m*A*σ<sup>n</sup>*t<sup>m-1</sup></b><li><b>Hyperbolic Sine Law</b> </li><b>ε̇= ε<sub>0</sub>* sinh(σ/(σ<sub>0</sub>))<sup>n</sup></b>.</ul> For the Power Law different formulations, like the <b>Norton</b>, <b>Strain Hardening</b> or <b>Time Hardening</b> are available. For the Hyperbolic Sine Law, the <b>Garofalo<b> formulation is available.</p> Schema name: StrainHardeningCreepFormulation # noqa: E501
- Returns
The type of this StrainHardeningCreepFormulation. # noqa: E501
- Return type
str
simscale_sdk.models.strain_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.strain_result_control_item.StrainResultControlItem(type='STRAIN', name=None, strain_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'strain_type': 'strainType', 'type': 'type'}¶
- property name¶
Gets the name of this StrainResultControlItem. # noqa: E501
- Returns
The name of this StrainResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'strain_type': 'OneOfStrainResultControlItemStrainType', 'type': 'str'}¶
- property strain_type¶
Gets the strain_type of this StrainResultControlItem. # noqa: E501
- Returns
The strain_type of this StrainResultControlItem. # noqa: E501
- Return type
OneOfStrainResultControlItemStrainType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StrainResultControlItem. # noqa: E501
Schema name: StrainResultControlItem # noqa: E501
- Returns
The type of this StrainResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.stress_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.stress_field_selection.StressFieldSelection(type='STRESS', stress_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'stress_type': 'stressType', 'type': 'type'}¶
- openapi_types = {'stress_type': 'OneOfStressFieldSelectionStressType', 'type': 'str'}¶
- property stress_type¶
Gets the stress_type of this StressFieldSelection. # noqa: E501
- Returns
The stress_type of this StressFieldSelection. # noqa: E501
- Return type
OneOfStressFieldSelectionStressType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StressFieldSelection. # noqa: E501
Schema name: StressFieldSelection # noqa: E501
- Returns
The type of this StressFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.stress_initial_condition_domains module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.stress_initial_condition_domains.StressInitialConditionDomains(_global=None, subdomains=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_global': 'global', 'subdomains': 'subdomains'}¶
- openapi_types = {'_global': 'StressTensorPressure', 'subdomains': 'list[SubdomainStressInitialCondition]'}¶
- property subdomains¶
Gets the subdomains of this StressInitialConditionDomains. # noqa: E501
- Returns
The subdomains of this StressInitialConditionDomains. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.stress_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.stress_result_control_item.StressResultControlItem(type='STRESS', name=None, stress_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'stress_type': 'stressType', 'type': 'type'}¶
- property name¶
Gets the name of this StressResultControlItem. # noqa: E501
- Returns
The name of this StressResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'stress_type': 'OneOfStressResultControlItemStressType', 'type': 'str'}¶
- property stress_type¶
Gets the stress_type of this StressResultControlItem. # noqa: E501
- Returns
The stress_type of this StressResultControlItem. # noqa: E501
- Return type
OneOfStressResultControlItemStressType
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this StressResultControlItem. # noqa: E501
Schema name: StressResultControlItem # noqa: E501
- Returns
The type of this StressResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.stress_tensor_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.stress_tensor_pressure.StressTensorPressure(sigma_xx=None, sigma_yy=None, sigma_zz=None, sigma_yz=None, sigma_xz=None, sigma_xy=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'sigma_xx': 'sigmaXX', 'sigma_xy': 'sigmaXY', 'sigma_xz': 'sigmaXZ', 'sigma_yy': 'sigmaYY', 'sigma_yz': 'sigmaYZ', 'sigma_zz': 'sigmaZZ', 'unit': 'unit'}¶
- openapi_types = {'sigma_xx': 'OneOfStressTensorPressureSigmaXX', 'sigma_xy': 'OneOfStressTensorPressureSigmaXY', 'sigma_xz': 'OneOfStressTensorPressureSigmaXZ', 'sigma_yy': 'OneOfStressTensorPressureSigmaYY', 'sigma_yz': 'OneOfStressTensorPressureSigmaYZ', 'sigma_zz': 'OneOfStressTensorPressureSigmaZZ', 'unit': 'str'}¶
- property sigma_xx¶
Gets the sigma_xx of this StressTensorPressure. # noqa: E501
- Returns
The sigma_xx of this StressTensorPressure. # noqa: E501
- Return type
OneOfStressTensorPressureSigmaXX
- property sigma_xy¶
Gets the sigma_xy of this StressTensorPressure. # noqa: E501
- Returns
The sigma_xy of this StressTensorPressure. # noqa: E501
- Return type
OneOfStressTensorPressureSigmaXY
- property sigma_xz¶
Gets the sigma_xz of this StressTensorPressure. # noqa: E501
- Returns
The sigma_xz of this StressTensorPressure. # noqa: E501
- Return type
OneOfStressTensorPressureSigmaXZ
- property sigma_yy¶
Gets the sigma_yy of this StressTensorPressure. # noqa: E501
- Returns
The sigma_yy of this StressTensorPressure. # noqa: E501
- Return type
OneOfStressTensorPressureSigmaYY
- property sigma_yz¶
Gets the sigma_yz of this StressTensorPressure. # noqa: E501
- Returns
The sigma_yz of this StressTensorPressure. # noqa: E501
- Return type
OneOfStressTensorPressureSigmaYZ
- property sigma_zz¶
Gets the sigma_zz of this StressTensorPressure. # noqa: E501
- Returns
The sigma_zz of this StressTensorPressure. # noqa: E501
- Return type
OneOfStressTensorPressureSigmaZZ
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this StressTensorPressure. # noqa: E501
- Returns
The unit of this StressTensorPressure. # noqa: E501
- Return type
str
simscale_sdk.models.subdomain_based_dimensional_vector_function_initial_condition_acceleration module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_based_dimensional_vector_function_initial_condition_acceleration.SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration(name=None, subdomain_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property name¶
Gets the name of this SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration. # noqa: E501
- Returns
The name of this SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'subdomain_value': 'DimensionalVectorFunctionAcceleration', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration. # noqa: E501
- Returns
The subdomain_value of this SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration. # noqa: E501
- Returns
The topological_reference of this SubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration. # noqa: E501
- Return type
simscale_sdk.models.subdomain_based_dimensional_vector_function_initial_condition_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_based_dimensional_vector_function_initial_condition_length.SubdomainBasedDimensionalVectorFunctionInitialConditionLength(name=None, subdomain_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property name¶
Gets the name of this SubdomainBasedDimensionalVectorFunctionInitialConditionLength. # noqa: E501
- Returns
The name of this SubdomainBasedDimensionalVectorFunctionInitialConditionLength. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'subdomain_value': 'DimensionalVectorFunctionLength', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainBasedDimensionalVectorFunctionInitialConditionLength. # noqa: E501
- Returns
The subdomain_value of this SubdomainBasedDimensionalVectorFunctionInitialConditionLength. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainBasedDimensionalVectorFunctionInitialConditionLength. # noqa: E501
- Returns
The topological_reference of this SubdomainBasedDimensionalVectorFunctionInitialConditionLength. # noqa: E501
- Return type
simscale_sdk.models.subdomain_based_dimensional_vector_function_initial_condition_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_based_dimensional_vector_function_initial_condition_speed.SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed(name=None, subdomain_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property name¶
Gets the name of this SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed. # noqa: E501
- Returns
The name of this SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'subdomain_value': 'DimensionalVectorFunctionSpeed', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed. # noqa: E501
- Returns
The subdomain_value of this SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed. # noqa: E501
- Returns
The topological_reference of this SubdomainBasedDimensionalVectorFunctionInitialConditionSpeed. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_function_initial_condition_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_function_initial_condition_temperature.SubdomainDimensionalFunctionInitialConditionTemperature(name=None, subdomain_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property name¶
Gets the name of this SubdomainDimensionalFunctionInitialConditionTemperature. # noqa: E501
- Returns
The name of this SubdomainDimensionalFunctionInitialConditionTemperature. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'subdomain_value': 'DimensionalFunctionTemperature', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalFunctionInitialConditionTemperature. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalFunctionInitialConditionTemperature. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalFunctionInitialConditionTemperature. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalFunctionInitialConditionTemperature. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_dimensionless module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_dimensionless.SubdomainDimensionalInitialConditionDimensionless(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalDimensionless', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionDimensionless. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_dynamic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_dynamic_viscosity.SubdomainDimensionalInitialConditionDynamicViscosity(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalDynamicViscosity', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionDynamicViscosity. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_kinematic_viscosity module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_kinematic_viscosity.SubdomainDimensionalInitialConditionKinematicViscosity(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalKinematicViscosity', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionKinematicViscosity. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_pressure module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_pressure.SubdomainDimensionalInitialConditionPressure(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalPressure', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionPressure. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_specific_turbulence_dissipation_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_specific_turbulence_dissipation_rate.SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalSpecificTurbulenceDissipationRate', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionSpecificTurbulenceDissipationRate. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_temperature.SubdomainDimensionalInitialConditionTemperature(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalTemperature', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionTemperature. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_turbulence_kinetic_energy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_turbulence_kinetic_energy.SubdomainDimensionalInitialConditionTurbulenceKineticEnergy(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalTurbulenceKineticEnergy', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionTurbulenceKineticEnergy. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_initial_condition_turbulent_dissipation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_initial_condition_turbulent_dissipation.SubdomainDimensionalInitialConditionTurbulentDissipation(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Returns
The name of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalTurbulentDissipation', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalInitialConditionTurbulentDissipation. # noqa: E501
- Return type
simscale_sdk.models.subdomain_dimensional_vector_initial_condition_speed module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_dimensional_vector_initial_condition_speed.SubdomainDimensionalVectorInitialConditionSpeed(name=None, subdomain_value=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Returns
The geometry_primitive_uuids of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Returns
The name of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Return type
str
- openapi_types = {'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'subdomain_value': 'DimensionalVectorSpeed', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Returns
The subdomain_value of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Returns
The topological_reference of this SubdomainDimensionalVectorInitialConditionSpeed. # noqa: E501
- Return type
simscale_sdk.models.subdomain_stress_initial_condition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.subdomain_stress_initial_condition.SubdomainStressInitialCondition(name=None, subdomain_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'subdomain_value': 'subdomainValue', 'topological_reference': 'topologicalReference'}¶
- property name¶
Gets the name of this SubdomainStressInitialCondition. # noqa: E501
- Returns
The name of this SubdomainStressInitialCondition. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'subdomain_value': 'StressTensorPressure', 'topological_reference': 'TopologicalReference'}¶
- property subdomain_value¶
Gets the subdomain_value of this SubdomainStressInitialCondition. # noqa: E501
- Returns
The subdomain_value of this SubdomainStressInitialCondition. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubdomainStressInitialCondition. # noqa: E501
- Returns
The topological_reference of this SubdomainStressInitialCondition. # noqa: E501
- Return type
simscale_sdk.models.submesh_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.submesh_refinement.SubmeshRefinement(type='SUBMESH', name=None, sizing=None, allow_quadrangles=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property allow_quadrangles¶
Gets the allow_quadrangles of this SubmeshRefinement. # noqa: E501
<p>This parameter determines if <a href=’https://www.simscale.com/docs/simulation-setup/meshing/tet-dominant/#quadrangles’ target=’_blank’><b>quadrangular surface elements</b></a> shall be allowed. When disabled, only triangles will be used. Meshing with triangles only is usually more robust while quadrangular elements may lead to better results.</p><p><img src=”/spec/resources/help/imgs/allow_quads_comparison.png” class=”helpPopupImage”/> The figure shows sample meshes with quadrangular surface elements disallowed (left) and allowed (right).</p> # noqa: E501
- Returns
The allow_quadrangles of this SubmeshRefinement. # noqa: E501
- Return type
bool
- attribute_map = {'allow_quadrangles': 'allowQuadrangles', 'name': 'name', 'sizing': 'sizing', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this SubmeshRefinement. # noqa: E501
- Returns
The name of this SubmeshRefinement. # noqa: E501
- Return type
str
- openapi_types = {'allow_quadrangles': 'bool', 'name': 'str', 'sizing': 'OneOfSubmeshRefinementSizing', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property sizing¶
Gets the sizing of this SubmeshRefinement. # noqa: E501
- Returns
The sizing of this SubmeshRefinement. # noqa: E501
- Return type
OneOfSubmeshRefinementSizing
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SubmeshRefinement. # noqa: E501
- Returns
The topological_reference of this SubmeshRefinement. # noqa: E501
- Return type
- property type¶
Gets the type of this SubmeshRefinement. # noqa: E501
<p>The refinement type <a href=’https://www.simscale.com/docs/simulation-setup/meshing/tet-dominant/#local-element-size’ target=’_blank’><b>local element size</b></a> allows the definition of local mesh sizings on particular faces or solids. This can be used to increase the mesh efficiency by using smaller elements only where needed, for example on contact surfaces, fillets or other regions with potentially large stress gradients.</p><p><img src=”/spec/resources/help/imgs/local_element_size.png” class=”helpPopupImage”/> The figure shows a mesh of a bolted connection with local refinements on the contact surfaces.</p> Schema name: SubmeshRefinement # noqa: E501
- Returns
The type of this SubmeshRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.sum_fields_calculation_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.sum_fields_calculation_result_control_item.SumFieldsCalculationResultControlItem(type='SUM_FIELDS_CALCULATION', name=None, field_selection=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_selection': 'fieldSelection', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property field_selection¶
Gets the field_selection of this SumFieldsCalculationResultControlItem. # noqa: E501
- Returns
The field_selection of this SumFieldsCalculationResultControlItem. # noqa: E501
- Return type
OneOfSumFieldsCalculationResultControlItemFieldSelection
- property name¶
Gets the name of this SumFieldsCalculationResultControlItem. # noqa: E501
- Returns
The name of this SumFieldsCalculationResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'field_selection': 'OneOfSumFieldsCalculationResultControlItemFieldSelection', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SumFieldsCalculationResultControlItem. # noqa: E501
- Returns
The topological_reference of this SumFieldsCalculationResultControlItem. # noqa: E501
- Return type
- property type¶
Gets the type of this SumFieldsCalculationResultControlItem. # noqa: E501
Schema name: SumFieldsCalculationResultControlItem # noqa: E501
- Returns
The type of this SumFieldsCalculationResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.surface_heat_flux_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_heat_flux_bc.SurfaceHeatFluxBC(type='SURFACE_HEAT_FLUX', name=None, heatflux_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heatflux_value': 'heatfluxValue', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property heatflux_value¶
Gets the heatflux_value of this SurfaceHeatFluxBC. # noqa: E501
- Returns
The heatflux_value of this SurfaceHeatFluxBC. # noqa: E501
- Return type
- property name¶
Gets the name of this SurfaceHeatFluxBC. # noqa: E501
- Returns
The name of this SurfaceHeatFluxBC. # noqa: E501
- Return type
str
- openapi_types = {'heatflux_value': 'DimensionalFunctionHeatFlux', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceHeatFluxBC. # noqa: E501
- Returns
The topological_reference of this SurfaceHeatFluxBC. # noqa: E501
- Return type
- property type¶
Gets the type of this SurfaceHeatFluxBC. # noqa: E501
Define the heatflux per unit area that enters the body through the assigned faces. Negative sign determines flux leaving the body. Schema name: SurfaceHeatFluxBC # noqa: E501
- Returns
The type of this SurfaceHeatFluxBC. # noqa: E501
- Return type
str
simscale_sdk.models.surface_load_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_load_bc.SurfaceLoadBC(type='SURFACE_LOAD', name=None, load=None, scaling=None, phase_angle=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'load': 'load', 'name': 'name', 'phase_angle': 'phaseAngle', 'scaling': 'scaling', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property load¶
Gets the load of this SurfaceLoadBC. # noqa: E501
- Returns
The load of this SurfaceLoadBC. # noqa: E501
- Return type
- property name¶
Gets the name of this SurfaceLoadBC. # noqa: E501
- Returns
The name of this SurfaceLoadBC. # noqa: E501
- Return type
str
- openapi_types = {'load': 'DimensionalVectorFunctionPressure', 'name': 'str', 'phase_angle': 'DimensionalAngle', 'scaling': 'DimensionalFunctionDimensionless', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this SurfaceLoadBC. # noqa: E501
- Returns
The phase_angle of this SurfaceLoadBC. # noqa: E501
- Return type
- property scaling¶
Gets the scaling of this SurfaceLoadBC. # noqa: E501
- Returns
The scaling of this SurfaceLoadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceLoadBC. # noqa: E501
- Returns
The topological_reference of this SurfaceLoadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this SurfaceLoadBC. # noqa: E501
This is a <b>surface load</b> boundary condition representing a distributed load on the selection. It is applied as surface traction in the global coordinate system.<br /><br />Important remarks: <br /><ul><li>The applied total force depends on the surface area of the selection</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/surface-load/’ target=’_blank’>Learn more</a>. Schema name: SurfaceLoadBC # noqa: E501
- Returns
The type of this SurfaceLoadBC. # noqa: E501
- Return type
str
simscale_sdk.models.surface_normal_gradient_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_normal_gradient_schemes.SurfaceNormalGradientSchemes(for_default=None, surface_normal_gradient_rho=None, surface_normal_gradient_pressure_rgh=None, surface_normal_gradient_rhok=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'for_default': 'forDefault', 'surface_normal_gradient_pressure_rgh': 'surfaceNormalGradient_pressureRgh', 'surface_normal_gradient_rho': 'surfaceNormalGradient_rho', 'surface_normal_gradient_rhok': 'surfaceNormalGradient_rhok'}¶
- property for_default¶
Gets the for_default of this SurfaceNormalGradientSchemes. # noqa: E501
- Returns
The for_default of this SurfaceNormalGradientSchemes. # noqa: E501
- Return type
OneOfSurfaceNormalGradientSchemesForDefault
- openapi_types = {'for_default': 'OneOfSurfaceNormalGradientSchemesForDefault', 'surface_normal_gradient_pressure_rgh': 'OneOfSurfaceNormalGradientSchemesSurfaceNormalGradientPressureRgh', 'surface_normal_gradient_rho': 'OneOfSurfaceNormalGradientSchemesSurfaceNormalGradientRho', 'surface_normal_gradient_rhok': 'OneOfSurfaceNormalGradientSchemesSurfaceNormalGradientRhok'}¶
- property surface_normal_gradient_pressure_rgh¶
Gets the surface_normal_gradient_pressure_rgh of this SurfaceNormalGradientSchemes. # noqa: E501
- Returns
The surface_normal_gradient_pressure_rgh of this SurfaceNormalGradientSchemes. # noqa: E501
- Return type
OneOfSurfaceNormalGradientSchemesSurfaceNormalGradientPressureRgh
- property surface_normal_gradient_rho¶
Gets the surface_normal_gradient_rho of this SurfaceNormalGradientSchemes. # noqa: E501
- Returns
The surface_normal_gradient_rho of this SurfaceNormalGradientSchemes. # noqa: E501
- Return type
OneOfSurfaceNormalGradientSchemesSurfaceNormalGradientRho
- property surface_normal_gradient_rhok¶
Gets the surface_normal_gradient_rhok of this SurfaceNormalGradientSchemes. # noqa: E501
- Returns
The surface_normal_gradient_rhok of this SurfaceNormalGradientSchemes. # noqa: E501
- Return type
OneOfSurfaceNormalGradientSchemesSurfaceNormalGradientRhok
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.surface_normals_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_normals_result_type.SurfaceNormalsResultType(type='SURFACE_NORMALS', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SurfaceNormalsResultType. # noqa: E501
Schema name: SurfaceNormalsResultType # noqa: E501
- Returns
The type of this SurfaceNormalsResultType. # noqa: E501
- Return type
str
simscale_sdk.models.surface_refinement module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_refinement.SurfaceRefinement(type='SURFACE_V3', name=None, min_level=None, max_level=None, cell_zone=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cell_zone': 'cellZone', 'max_level': 'maxLevel', 'min_level': 'minLevel', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property cell_zone¶
Gets the cell_zone of this SurfaceRefinement. # noqa: E501
- Returns
The cell_zone of this SurfaceRefinement. # noqa: E501
- Return type
OneOfSurfaceRefinementCellZone
- property max_level¶
Gets the max_level of this SurfaceRefinement. # noqa: E501
<p>Specify surface-wise the maximum refinement level for this surface.</p> # noqa: E501
- Returns
The max_level of this SurfaceRefinement. # noqa: E501
- Return type
int
- property min_level¶
Gets the min_level of this SurfaceRefinement. # noqa: E501
<p>Specify surface-wise the minimum refinement level for this surface.</p> # noqa: E501
- Returns
The min_level of this SurfaceRefinement. # noqa: E501
- Return type
int
- property name¶
Gets the name of this SurfaceRefinement. # noqa: E501
- Returns
The name of this SurfaceRefinement. # noqa: E501
- Return type
str
- openapi_types = {'cell_zone': 'OneOfSurfaceRefinementCellZone', 'max_level': 'int', 'min_level': 'int', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceRefinement. # noqa: E501
- Returns
The topological_reference of this SurfaceRefinement. # noqa: E501
- Return type
- property type¶
Gets the type of this SurfaceRefinement. # noqa: E501
A <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#surface-refinement’ target=’_blank’><b>surface refinement</b></a> can be used to refine the mesh near the surfaces of assigned faces and/or solids. A surface refinement can also be used to create a <u>cell zone</u>. Schema name: SurfaceRefinement # noqa: E501
- Returns
The type of this SurfaceRefinement. # noqa: E501
- Return type
str
simscale_sdk.models.surface_refinement_hex_dominant_snappy module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_refinement_hex_dominant_snappy.SurfaceRefinementHexDominantSnappy(type='SURFACE_HEX_DOMINANT_SNAPPY_V3', name=None, min_length=None, max_length=None, cell_zone=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cell_zone': 'cellZone', 'max_length': 'maxLength', 'min_length': 'minLength', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property cell_zone¶
Gets the cell_zone of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Returns
The cell_zone of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Return type
OneOfSurfaceRefinementHexDominantSnappyCellZone
- property max_length¶
Gets the max_length of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Returns
The max_length of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Return type
- property min_length¶
Gets the min_length of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Returns
The min_length of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Return type
- property name¶
Gets the name of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Returns
The name of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Return type
str
- openapi_types = {'cell_zone': 'OneOfSurfaceRefinementHexDominantSnappyCellZone', 'max_length': 'DimensionalLength', 'min_length': 'DimensionalLength', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Returns
The topological_reference of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Return type
- property type¶
Gets the type of this SurfaceRefinementHexDominantSnappy. # noqa: E501
A <a href=’https://www.simscale.com/docs/simulation-setup/meshing/hex-dominant/#surface-refinement’ target=’_blank’><b>surface refinement</b></a> can be used to refine the mesh near the surfaces of assigned faces and/or solids. A surface refinement can also be used to create a <u>cell zone</u>. Schema name: SurfaceRefinementHexDominantSnappy # noqa: E501
- Returns
The type of this SurfaceRefinementHexDominantSnappy. # noqa: E501
- Return type
str
simscale_sdk.models.surface_refinement_pacefish module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_refinement_pacefish.SurfaceRefinementPacefish(type='SURFACE_PACEFISH', name=None, target_resolution=None, buffer_cells_no_extrude=None, additional_directional_cells=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property additional_directional_cells¶
Gets the additional_directional_cells of this SurfaceRefinementPacefish. # noqa: E501
- Returns
The additional_directional_cells of this SurfaceRefinementPacefish. # noqa: E501
- Return type
- attribute_map = {'additional_directional_cells': 'additionalDirectionalCells', 'buffer_cells_no_extrude': 'bufferCellsNoExtrude', 'name': 'name', 'target_resolution': 'targetResolution', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property buffer_cells_no_extrude¶
Gets the buffer_cells_no_extrude of this SurfaceRefinementPacefish. # noqa: E501
Specify the minimum number of buffer cells between regions of different refinements. # noqa: E501
- Returns
The buffer_cells_no_extrude of this SurfaceRefinementPacefish. # noqa: E501
- Return type
int
- property name¶
Gets the name of this SurfaceRefinementPacefish. # noqa: E501
- Returns
The name of this SurfaceRefinementPacefish. # noqa: E501
- Return type
str
- openapi_types = {'additional_directional_cells': 'AdditionalDirectionalCells', 'buffer_cells_no_extrude': 'int', 'name': 'str', 'target_resolution': 'DimensionalLength', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property target_resolution¶
Gets the target_resolution of this SurfaceRefinementPacefish. # noqa: E501
- Returns
The target_resolution of this SurfaceRefinementPacefish. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceRefinementPacefish. # noqa: E501
- Returns
The topological_reference of this SurfaceRefinementPacefish. # noqa: E501
- Return type
- property type¶
Gets the type of this SurfaceRefinementPacefish. # noqa: E501
Schema name: SurfaceRefinementPacefish # noqa: E501
- Returns
The type of this SurfaceRefinementPacefish. # noqa: E501
- Return type
str
simscale_sdk.models.surface_refinement_wind_comfort module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_refinement_wind_comfort.SurfaceRefinementWindComfort(type='SURFACE_REFINEMENT_WIND_COMFORT', name=None, new_fineness=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'new_fineness': 'newFineness', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this SurfaceRefinementWindComfort. # noqa: E501
- Returns
The name of this SurfaceRefinementWindComfort. # noqa: E501
- Return type
str
- property new_fineness¶
Gets the new_fineness of this SurfaceRefinementWindComfort. # noqa: E501
- Returns
The new_fineness of this SurfaceRefinementWindComfort. # noqa: E501
- Return type
OneOfSurfaceRefinementWindComfortNewFineness
- openapi_types = {'name': 'str', 'new_fineness': 'OneOfSurfaceRefinementWindComfortNewFineness', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceRefinementWindComfort. # noqa: E501
- Returns
The topological_reference of this SurfaceRefinementWindComfort. # noqa: E501
- Return type
- property type¶
Gets the type of this SurfaceRefinementWindComfort. # noqa: E501
Schema name: SurfaceRefinementWindComfort # noqa: E501
- Returns
The type of this SurfaceRefinementWindComfort. # noqa: E501
- Return type
str
simscale_sdk.models.surface_roughness module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.surface_roughness.SurfaceRoughness(name=None, surface_roughness=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'surface_roughness': 'surfaceRoughness', 'topological_reference': 'topologicalReference'}¶
- property name¶
Gets the name of this SurfaceRoughness. # noqa: E501
- Returns
The name of this SurfaceRoughness. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'surface_roughness': 'DimensionalLength', 'topological_reference': 'TopologicalReference'}¶
- property surface_roughness¶
Gets the surface_roughness of this SurfaceRoughness. # noqa: E501
- Returns
The surface_roughness of this SurfaceRoughness. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SurfaceRoughness. # noqa: E501
- Returns
The topological_reference of this SurfaceRoughness. # noqa: E501
- Return type
simscale_sdk.models.sutherland_transport module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.sutherland_transport.SutherlandTransport(type='SUTHERLAND', reference_viscosity=None, reference_temperature=None, ts=None, thermo=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'reference_temperature': 'referenceTemperature', 'reference_viscosity': 'referenceViscosity', 'thermo': 'thermo', 'ts': 'ts', 'type': 'type'}¶
- openapi_types = {'reference_temperature': 'DimensionalTemperature', 'reference_viscosity': 'DimensionalDynamicViscosity', 'thermo': 'OneOfSutherlandTransportThermo', 'ts': 'DimensionalTemperature', 'type': 'str'}¶
- property reference_temperature¶
Gets the reference_temperature of this SutherlandTransport. # noqa: E501
- Returns
The reference_temperature of this SutherlandTransport. # noqa: E501
- Return type
- property reference_viscosity¶
Gets the reference_viscosity of this SutherlandTransport. # noqa: E501
- Returns
The reference_viscosity of this SutherlandTransport. # noqa: E501
- Return type
- property thermo¶
Gets the thermo of this SutherlandTransport. # noqa: E501
- Returns
The thermo of this SutherlandTransport. # noqa: E501
- Return type
OneOfSutherlandTransportThermo
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property ts¶
Gets the ts of this SutherlandTransport. # noqa: E501
- Returns
The ts of this SutherlandTransport. # noqa: E501
- Return type
- property type¶
Gets the type of this SutherlandTransport. # noqa: E501
Schema name: SutherlandTransport # noqa: E501
- Returns
The type of this SutherlandTransport. # noqa: E501
- Return type
str
simscale_sdk.models.sycamore module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.sycamore.Sycamore(type='SYCAMORE', average_tree_height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'average_tree_height': 'averageTreeHeight', 'type': 'type'}¶
- property average_tree_height¶
Gets the average_tree_height of this Sycamore. # noqa: E501
- Returns
The average_tree_height of this Sycamore. # noqa: E501
- Return type
- openapi_types = {'average_tree_height': 'DimensionalLength', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this Sycamore. # noqa: E501
Schema name: Sycamore # noqa: E501
- Returns
The type of this Sycamore. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_bc.SymmetryBC(type='SYMMETRY', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this SymmetryBC. # noqa: E501
- Returns
The name of this SymmetryBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SymmetryBC. # noqa: E501
- Returns
The topological_reference of this SymmetryBC. # noqa: E501
- Return type
- property type¶
Gets the type of this SymmetryBC. # noqa: E501
This boundary condition provides a symmetry condition on any face by applying a mirror effect. The fluxes and the normal components across the symmetry face are set to zero. <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/symmetry/’ target=’_blank’>Learn more</a>. Schema name: SymmetryBC # noqa: E501
- Returns
The type of this SymmetryBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_dvbc.SymmetryDVBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryDVBC. # noqa: E501
Schema name: SymmetryDVBC # noqa: E501
- Returns
The type of this SymmetryDVBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_ebc.SymmetryEBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryEBC. # noqa: E501
Schema name: SymmetryEBC # noqa: E501
- Returns
The type of this SymmetryEBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_evbc.SymmetryEVBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryEVBC. # noqa: E501
Schema name: SymmetryEVBC # noqa: E501
- Returns
The type of this SymmetryEVBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_evcbc.SymmetryEVCBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryEVCBC. # noqa: E501
Schema name: SymmetryEVCBC # noqa: E501
- Returns
The type of this SymmetryEVCBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_nbc.SymmetryNBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryNBC. # noqa: E501
Schema name: SymmetryNBC # noqa: E501
- Returns
The type of this SymmetryNBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_obc.SymmetryOBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryOBC. # noqa: E501
Schema name: SymmetryOBC # noqa: E501
- Returns
The type of this SymmetryOBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_pbc.SymmetryPBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryPBC. # noqa: E501
Schema name: SymmetryPBC # noqa: E501
- Returns
The type of this SymmetryPBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_pfbc.SymmetryPFBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryPFBC. # noqa: E501
Schema name: SymmetryPFBC # noqa: E501
- Returns
The type of this SymmetryPFBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_plane_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_plane_bc.SymmetryPlaneBC(type='SYMMETRY_PLANE', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this SymmetryPlaneBC. # noqa: E501
- Returns
The name of this SymmetryPlaneBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this SymmetryPlaneBC. # noqa: E501
- Returns
The topological_reference of this SymmetryPlaneBC. # noqa: E501
- Return type
- property type¶
Gets the type of this SymmetryPlaneBC. # noqa: E501
This boundary condition restrains the displacement of a face in its normal direction in order to represent a symmetry plane of the structure. Use this boundary condition to reduce the model size significantly if the geometry and the loading conditions are symmetric.<br /><br />Important remarks: <br /><ul><li>The solver uses linear relations between all three DOFs to constrian the normal movement, thus overcontraint conditions may appear if the edges of the selected faces are constrained by other displacement boundary conditions.</li><li>If the assigned faces are orthogonal to a global coordinate axes, it is recommended to directly specifiy the symmetry conditions with a <b>Fixed value</b> boundary condition.</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/symmetry/#symmetry-plane-boundary-condition-fea’ target=’_blank’>Learn more</a>. Schema name: SymmetryPlaneBC # noqa: E501
- Returns
The type of this SymmetryPlaneBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_psbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_psbc.SymmetryPSBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryPSBC. # noqa: E501
Schema name: SymmetryPSBC # noqa: E501
- Returns
The type of this SymmetryPSBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_tbc.SymmetryTBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryTBC. # noqa: E501
Schema name: SymmetryTBC # noqa: E501
- Returns
The type of this SymmetryTBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_tdbc.SymmetryTDBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryTDBC. # noqa: E501
Schema name: SymmetryTDBC # noqa: E501
- Returns
The type of this SymmetryTDBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_tdcbc.SymmetryTDCBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryTDCBC. # noqa: E501
Schema name: SymmetryTDCBC # noqa: E501
- Returns
The type of this SymmetryTDCBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_tkebc.SymmetryTKEBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryTKEBC. # noqa: E501
Schema name: SymmetryTKEBC # noqa: E501
- Returns
The type of this SymmetryTKEBC. # noqa: E501
- Return type
str
simscale_sdk.models.symmetry_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.symmetry_vbc.SymmetryVBC(type='SYMMETRY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SymmetryVBC. # noqa: E501
Schema name: SymmetryVBC # noqa: E501
- Returns
The type of this SymmetryVBC. # noqa: E501
- Return type
str
simscale_sdk.models.synchronize_with_field_output_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.synchronize_with_field_output_write_control.SynchronizeWithFieldOutputWriteControl(type='OUTPUT_TIME', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this SynchronizeWithFieldOutputWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: SynchronizeWithFieldOutputWriteControl # noqa: E501
- Returns
The type of this SynchronizeWithFieldOutputWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this SynchronizeWithFieldOutputWriteControl. # noqa: E501
- Returns
The write_interval of this SynchronizeWithFieldOutputWriteControl. # noqa: E501
- Return type
float
simscale_sdk.models.table_defined_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_defined_function.TableDefinedFunction(type='TABLE_DEFINED', label=None, table_id=None, result_index=None, independent_variables=None, separator=None, out_of_bounds=None, interpolation=None, left_extrapolation=None, right_extrapolation=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'independent_variables': 'independentVariables', 'interpolation': 'interpolation', 'label': 'label', 'left_extrapolation': 'leftExtrapolation', 'out_of_bounds': 'outOfBounds', 'result_index': 'resultIndex', 'right_extrapolation': 'rightExtrapolation', 'separator': 'separator', 'table_id': 'tableId', 'type': 'type'}¶
- property independent_variables¶
Gets the independent_variables of this TableDefinedFunction. # noqa: E501
- Returns
The independent_variables of this TableDefinedFunction. # noqa: E501
- Return type
list[TableFunctionParameter]
- property interpolation¶
Gets the interpolation of this TableDefinedFunction. # noqa: E501
- Returns
The interpolation of this TableDefinedFunction. # noqa: E501
- Return type
str
- property label¶
Gets the label of this TableDefinedFunction. # noqa: E501
- Returns
The label of this TableDefinedFunction. # noqa: E501
- Return type
str
- property left_extrapolation¶
Gets the left_extrapolation of this TableDefinedFunction. # noqa: E501
- Returns
The left_extrapolation of this TableDefinedFunction. # noqa: E501
- Return type
str
- openapi_types = {'independent_variables': 'list[TableFunctionParameter]', 'interpolation': 'str', 'label': 'str', 'left_extrapolation': 'str', 'out_of_bounds': 'str', 'result_index': 'list[int]', 'right_extrapolation': 'str', 'separator': 'str', 'table_id': 'str', 'type': 'str'}¶
- property out_of_bounds¶
Gets the out_of_bounds of this TableDefinedFunction. # noqa: E501
- Returns
The out_of_bounds of this TableDefinedFunction. # noqa: E501
- Return type
str
- property result_index¶
Gets the result_index of this TableDefinedFunction. # noqa: E501
Indicates which column(s) of the table contains the result values. One-based indexing must be used. For example, set this field to ‘[2]’ if the second column of the table contains the dependent variable values. # noqa: E501
- Returns
The result_index of this TableDefinedFunction. # noqa: E501
- Return type
list[int]
- property right_extrapolation¶
Gets the right_extrapolation of this TableDefinedFunction. # noqa: E501
- Returns
The right_extrapolation of this TableDefinedFunction. # noqa: E501
- Return type
str
- property separator¶
Gets the separator of this TableDefinedFunction. # noqa: E501
Values in each row are separated by this character. Also known as a delimiter. # noqa: E501
- Returns
The separator of this TableDefinedFunction. # noqa: E501
- Return type
str
- property table_id¶
Gets the table_id of this TableDefinedFunction. # noqa: E501
The ID of the imported table. # noqa: E501
- Returns
The table_id of this TableDefinedFunction. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TableDefinedFunction. # noqa: E501
Schema name: TableDefinedFunction # noqa: E501
- Returns
The type of this TableDefinedFunction. # noqa: E501
- Return type
str
simscale_sdk.models.table_defined_probe_locations module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_defined_probe_locations.TableDefinedProbeLocations(type='TABULAR', table_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'table_id': 'tableId', 'type': 'type'}¶
- openapi_types = {'table_id': 'str', 'type': 'str'}¶
- property table_id¶
Gets the table_id of this TableDefinedProbeLocations. # noqa: E501
The ID of the imported table. # noqa: E501
- Returns
The table_id of this TableDefinedProbeLocations. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TableDefinedProbeLocations. # noqa: E501
Schema name: TableDefinedProbeLocations # noqa: E501
- Returns
The type of this TableDefinedProbeLocations. # noqa: E501
- Return type
str
simscale_sdk.models.table_defined_vector_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_defined_vector_function.TableDefinedVectorFunction(type='TABLE_DEFINED', label=None, table_id=None, result_index=None, independent_variables=None, separator=None, out_of_bounds=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'independent_variables': 'independentVariables', 'label': 'label', 'out_of_bounds': 'outOfBounds', 'result_index': 'resultIndex', 'separator': 'separator', 'table_id': 'tableId', 'type': 'type'}¶
- property independent_variables¶
Gets the independent_variables of this TableDefinedVectorFunction. # noqa: E501
- Returns
The independent_variables of this TableDefinedVectorFunction. # noqa: E501
- Return type
list[TableFunctionParameter]
- property label¶
Gets the label of this TableDefinedVectorFunction. # noqa: E501
- Returns
The label of this TableDefinedVectorFunction. # noqa: E501
- Return type
str
- openapi_types = {'independent_variables': 'list[TableFunctionParameter]', 'label': 'str', 'out_of_bounds': 'str', 'result_index': 'list[int]', 'separator': 'str', 'table_id': 'str', 'type': 'str'}¶
- property out_of_bounds¶
Gets the out_of_bounds of this TableDefinedVectorFunction. # noqa: E501
- Returns
The out_of_bounds of this TableDefinedVectorFunction. # noqa: E501
- Return type
str
- property result_index¶
Gets the result_index of this TableDefinedVectorFunction. # noqa: E501
Indicates which column(s) of the table contains the result values. One-based indexing must be used. For example, set this field to ‘[2]’ if the second column of the table contains the dependent variable values. # noqa: E501
- Returns
The result_index of this TableDefinedVectorFunction. # noqa: E501
- Return type
list[int]
- property separator¶
Gets the separator of this TableDefinedVectorFunction. # noqa: E501
Values in each row are separated by this character. Also known as a delimiter. # noqa: E501
- Returns
The separator of this TableDefinedVectorFunction. # noqa: E501
- Return type
str
- property table_id¶
Gets the table_id of this TableDefinedVectorFunction. # noqa: E501
The ID of the imported table. # noqa: E501
- Returns
The table_id of this TableDefinedVectorFunction. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TableDefinedVectorFunction. # noqa: E501
Schema name: TableDefinedVectorFunction # noqa: E501
- Returns
The type of this TableDefinedVectorFunction. # noqa: E501
- Return type
str
simscale_sdk.models.table_function_parameter module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_function_parameter.TableFunctionParameter(reference=None, parameter=None, unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'parameter': 'parameter', 'reference': 'reference', 'unit': 'unit'}¶
- openapi_types = {'parameter': 'str', 'reference': 'int', 'unit': 'str'}¶
- property parameter¶
Gets the parameter of this TableFunctionParameter. # noqa: E501
The name of the independent variable. Possible values: ‘X’, ‘Y’, ‘Z’, ‘HEIGHT’, ‘Temperature’, ‘T’ (time), ‘Q’ (mass flow rate), ‘V_DOT’ (volumetric flow rate), ‘F’ (frequency), ‘E’ (strain) # noqa: E501
- Returns
The parameter of this TableFunctionParameter. # noqa: E501
- Return type
str
- property reference¶
Gets the reference of this TableFunctionParameter. # noqa: E501
Indicates which column of the table contains the values of this independent variable. One-based indexing must be used. For example, set this property to ‘1’ if the first column of the table contains the values of this independent variable. # noqa: E501
- Returns
The reference of this TableFunctionParameter. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this TableFunctionParameter. # noqa: E501
- Returns
The unit of this TableFunctionParameter. # noqa: E501
- Return type
str
simscale_sdk.models.table_import_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_import_request.TableImportRequest(location=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'location': 'location'}¶
- property location¶
Gets the location of this TableImportRequest. # noqa: E501
- Returns
The location of this TableImportRequest. # noqa: E501
- Return type
- openapi_types = {'location': 'TableImportRequestLocation'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.table_import_request_location module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_import_request_location.TableImportRequestLocation(storage_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'storage_id': 'storageId'}¶
- openapi_types = {'storage_id': 'str'}¶
- property storage_id¶
Gets the storage_id of this TableImportRequestLocation. # noqa: E501
The storage ID of the temporary storage location where the table has been uploaded. # noqa: E501
- Returns
The storage_id of this TableImportRequestLocation. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.table_import_response module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.table_import_response.TableImportResponse(table_id=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'table_id': 'tableId'}¶
- openapi_types = {'table_id': 'str'}¶
- property table_id¶
Gets the table_id of this TableImportResponse. # noqa: E501
The ID of the imported table. # noqa: E501
- Returns
The table_id of this TableImportResponse. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.tadmor_flux_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.tadmor_flux_scheme.TadmorFluxScheme(type='TADMOR', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TadmorFluxScheme. # noqa: E501
Schema name: TadmorFluxScheme # noqa: E501
- Returns
The type of this TadmorFluxScheme. # noqa: E501
- Return type
str
simscale_sdk.models.tangent_jacobian_matrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.tangent_jacobian_matrix.TangentJacobianMatrix(type='TANGENT', max_newton_iteration=None, reactualization_iteration=None, reactualization_increment=None, change_jacobian_matrix=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'change_jacobian_matrix': 'changeJacobianMatrix', 'max_newton_iteration': 'maxNewtonIteration', 'reactualization_increment': 'reactualizationIncrement', 'reactualization_iteration': 'reactualizationIteration', 'type': 'type'}¶
- property change_jacobian_matrix¶
Gets the change_jacobian_matrix of this TangentJacobianMatrix. # noqa: E501
- Returns
The change_jacobian_matrix of this TangentJacobianMatrix. # noqa: E501
- Return type
OneOfTangentJacobianMatrixChangeJacobianMatrix
- property max_newton_iteration¶
Gets the max_newton_iteration of this TangentJacobianMatrix. # noqa: E501
<p>Maximum number of allowed Newton iterations per time increment. If this value is reached the simulation is considered non-converging. If an automatic time stepping is activated the time increment is reduced in order to reach convergence.</p> # noqa: E501
- Returns
The max_newton_iteration of this TangentJacobianMatrix. # noqa: E501
- Return type
int
- openapi_types = {'change_jacobian_matrix': 'OneOfTangentJacobianMatrixChangeJacobianMatrix', 'max_newton_iteration': 'int', 'reactualization_increment': 'int', 'reactualization_iteration': 'int', 'type': 'str'}¶
- property reactualization_increment¶
Gets the reactualization_increment of this TangentJacobianMatrix. # noqa: E501
<p>Select how often the Jacobian matrix should be recomputed. If this parameter is set to 10, the Jacobian matrix is recomputed every 10th time step. If it is set to 0, the Jacobian matrix is never updated.</p> # noqa: E501
- Returns
The reactualization_increment of this TangentJacobianMatrix. # noqa: E501
- Return type
int
- property reactualization_iteration¶
Gets the reactualization_iteration of this TangentJacobianMatrix. # noqa: E501
<p>Select how often the Jacobian matrix should be recomputed. If this parameter is set to 10, the Jacobian matrix is recomputed every 10th iteration within a given time step. If it is set to 0, the Jacobian matrix is not updated within any time step.</p> # noqa: E501
- Returns
The reactualization_iteration of this TangentJacobianMatrix. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TangentJacobianMatrix. # noqa: E501
<p>Select which stiffnes matrix should be used for computing the Jacobian of the Newton method. Choosing the tangent stiffnes matrix via <b>tangent matrix</b> allows a full Newton approach whereas the selection of the <b>elastic matrix</b> results in a quasi-Newton approach.</p> Schema name: TangentJacobianMatrix # noqa: E501
- Returns
The type of this TangentJacobianMatrix. # noqa: E501
- Return type
str
simscale_sdk.models.tchamwa_time_integration_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.tchamwa_time_integration_scheme.TchamwaTimeIntegrationScheme(type='TCHAMWA', phi=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'phi': 'phi', 'type': 'type'}¶
- openapi_types = {'phi': 'float', 'type': 'str'}¶
- property phi¶
Gets the phi of this TchamwaTimeIntegrationScheme. # noqa: E501
<p>The parameter <b>φ</b> allows inducing numerical damping. For <b>φ</b> = 1.0 there is no numerical damping whereas for <b>φ</b> > 1.0</p> the damping grows with the parameter value. It is thus not recommended to use a value for <b>φ</b> greater than 1.1.</p> # noqa: E501
- Returns
The phi of this TchamwaTimeIntegrationScheme. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TchamwaTimeIntegrationScheme. # noqa: E501
Schema name: TchamwaTimeIntegrationScheme # noqa: E501
- Returns
The type of this TchamwaTimeIntegrationScheme. # noqa: E501
- Return type
str
simscale_sdk.models.temperature_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.temperature_field_selection.TemperatureFieldSelection(type='TEMPERATURE', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this TemperatureFieldSelection. # noqa: E501
- Returns
The component_selection of this TemperatureFieldSelection. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TemperatureFieldSelection. # noqa: E501
Schema name: TemperatureFieldSelection # noqa: E501
- Returns
The type of this TemperatureFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.temperature_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.temperature_result_control_item.TemperatureResultControlItem(type='TEMPERATURE', name=None, temperature_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'temperature_type': 'temperatureType', 'type': 'type'}¶
- property name¶
Gets the name of this TemperatureResultControlItem. # noqa: E501
- Returns
The name of this TemperatureResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'temperature_type': 'str', 'type': 'str'}¶
- property temperature_type¶
Gets the temperature_type of this TemperatureResultControlItem. # noqa: E501
- Returns
The temperature_type of this TemperatureResultControlItem. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TemperatureResultControlItem. # noqa: E501
Schema name: TemperatureResultControlItem # noqa: E501
- Returns
The type of this TemperatureResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.temporal_response_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.temporal_response_result_control_item.TemporalResponseResultControlItem(type='TEMPORAL_RESPONSE', name=None, field_selection=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'field_selection': 'fieldSelection', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'name': 'name', 'type': 'type'}¶
- property field_selection¶
Gets the field_selection of this TemporalResponseResultControlItem. # noqa: E501
- Returns
The field_selection of this TemporalResponseResultControlItem. # noqa: E501
- Return type
OneOfTemporalResponseResultControlItemFieldSelection
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this TemporalResponseResultControlItem. # noqa: E501
- Returns
The geometry_primitive_uuids of this TemporalResponseResultControlItem. # noqa: E501
- Return type
list[str]
- property name¶
Gets the name of this TemporalResponseResultControlItem. # noqa: E501
- Returns
The name of this TemporalResponseResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'field_selection': 'OneOfTemporalResponseResultControlItemFieldSelection', 'geometry_primitive_uuids': 'list[str]', 'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TemporalResponseResultControlItem. # noqa: E501
Schema name: TemporalResponseResultControlItem # noqa: E501
- Returns
The type of this TemporalResponseResultControlItem. # noqa: E501
- Return type
str
simscale_sdk.models.thermal_mechanical module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.thermal_mechanical.ThermalMechanical(type='THERMAL_MECHANICAL', time_dependency=None, inertia_effect=None, non_linear_analysis=None, connection_groups=None, element_technology=None, model=None, materials=None, initial_conditions=None, boundary_conditions=None, numerics=None, simulation_control=None, result_control=None, mesh_order=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'boundary_conditions': 'boundaryConditions', 'connection_groups': 'connectionGroups', 'element_technology': 'elementTechnology', 'inertia_effect': 'inertiaEffect', 'initial_conditions': 'initialConditions', 'materials': 'materials', 'mesh_order': 'meshOrder', 'model': 'model', 'non_linear_analysis': 'nonLinearAnalysis', 'numerics': 'numerics', 'result_control': 'resultControl', 'simulation_control': 'simulationControl', 'time_dependency': 'timeDependency', 'type': 'type'}¶
- property boundary_conditions¶
Gets the boundary_conditions of this ThermalMechanical. # noqa: E501
- Returns
The boundary_conditions of this ThermalMechanical. # noqa: E501
- Return type
list[OneOfThermalMechanicalBoundaryConditions]
- property connection_groups¶
Gets the connection_groups of this ThermalMechanical. # noqa: E501
- Returns
The connection_groups of this ThermalMechanical. # noqa: E501
- Return type
list[OneOfThermalMechanicalConnectionGroups]
- property element_technology¶
Gets the element_technology of this ThermalMechanical. # noqa: E501
- Returns
The element_technology of this ThermalMechanical. # noqa: E501
- Return type
- property inertia_effect¶
Gets the inertia_effect of this ThermalMechanical. # noqa: E501
<p>Select if inertia effects should be considered in the analysis. If high loading accelerations or impacts are present then <b>dynamic</b> is the right choice for this parameter. If the dynamic effects are negligible, <b>static</b> should be selected.</p> # noqa: E501
- Returns
The inertia_effect of this ThermalMechanical. # noqa: E501
- Return type
str
- property initial_conditions¶
Gets the initial_conditions of this ThermalMechanical. # noqa: E501
- Returns
The initial_conditions of this ThermalMechanical. # noqa: E501
- Return type
- property materials¶
Gets the materials of this ThermalMechanical. # noqa: E501
- Returns
The materials of this ThermalMechanical. # noqa: E501
- Return type
list[SolidMaterial]
- property mesh_order¶
Gets the mesh_order of this ThermalMechanical. # noqa: E501
- Returns
The mesh_order of this ThermalMechanical. # noqa: E501
- Return type
str
- property model¶
Gets the model of this ThermalMechanical. # noqa: E501
- Returns
The model of this ThermalMechanical. # noqa: E501
- Return type
- property non_linear_analysis¶
Gets the non_linear_analysis of this ThermalMechanical. # noqa: E501
<p>Choose if your analysis should feature any kind of <b>nonlinearity</b> like <b>physical contacts, nonlinear materials</b> as hyperelasticity or plasticity or <b>large rotations</b> and <b>large deformations, temperature dependant material properties</b> or <b>temperature dependant boundary conditions</b>. For a <b>linear analysis</b> none of those nonlinearities are available.</p> # noqa: E501
- Returns
The non_linear_analysis of this ThermalMechanical. # noqa: E501
- Return type
bool
- property numerics¶
Gets the numerics of this ThermalMechanical. # noqa: E501
- Returns
The numerics of this ThermalMechanical. # noqa: E501
- Return type
- openapi_types = {'boundary_conditions': 'list[OneOfThermalMechanicalBoundaryConditions]', 'connection_groups': 'list[OneOfThermalMechanicalConnectionGroups]', 'element_technology': 'SolidElementTechnology', 'inertia_effect': 'str', 'initial_conditions': 'SolidInitialConditions', 'materials': 'list[SolidMaterial]', 'mesh_order': 'str', 'model': 'SolidModel', 'non_linear_analysis': 'bool', 'numerics': 'SolidNumerics', 'result_control': 'SolidResultControl', 'simulation_control': 'SolidSimulationControl', 'time_dependency': 'OneOfThermalMechanicalTimeDependency', 'type': 'str'}¶
- property result_control¶
Gets the result_control of this ThermalMechanical. # noqa: E501
- Returns
The result_control of this ThermalMechanical. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this ThermalMechanical. # noqa: E501
- Returns
The simulation_control of this ThermalMechanical. # noqa: E501
- Return type
- property time_dependency¶
Gets the time_dependency of this ThermalMechanical. # noqa: E501
- Returns
The time_dependency of this ThermalMechanical. # noqa: E501
- Return type
OneOfThermalMechanicalTimeDependency
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ThermalMechanical. # noqa: E501
Schema name: ThermalMechanical # noqa: E501
- Returns
The type of this ThermalMechanical. # noqa: E501
- Return type
str
simscale_sdk.models.theta_method_time_integration_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.theta_method_time_integration_type.ThetaMethodTimeIntegrationType(type='THETA_METHOD', theta=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'theta': 'theta', 'type': 'type'}¶
- openapi_types = {'theta': 'float', 'type': 'str'}¶
- property theta¶
Gets the theta of this ThetaMethodTimeIntegrationType. # noqa: E501
The parameter <b>θ</b> must be ranging between 0.0 (explicit method) and 1.0 (completely implicit method). The standard value of <b>θ</b> = 0.57 is chosen a little higher than <b>θ</b> = 0.5 which would lead to the <i>Crank-Nicolson</i> scheme of order 2. # noqa: E501
- Returns
The theta of this ThetaMethodTimeIntegrationType. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ThetaMethodTimeIntegrationType. # noqa: E501
<p>Choose the time integration scheme type</p> Schema name: ThetaMethodTimeIntegrationType # noqa: E501
- Returns
The type of this ThetaMethodTimeIntegrationType. # noqa: E501
- Return type
str
simscale_sdk.models.time_and_place_sun_direction module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.time_and_place_sun_direction.TimeAndPlaceSunDirection(type='TIME_AND_PLACE', north_angle=None, geographical_location=None, local_date_time=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geographical_location': 'geographicalLocation', 'local_date_time': 'localDateTime', 'north_angle': 'northAngle', 'type': 'type'}¶
- property geographical_location¶
Gets the geographical_location of this TimeAndPlaceSunDirection. # noqa: E501
- Returns
The geographical_location of this TimeAndPlaceSunDirection. # noqa: E501
- Return type
- property local_date_time¶
Gets the local_date_time of this TimeAndPlaceSunDirection. # noqa: E501
- Returns
The local_date_time of this TimeAndPlaceSunDirection. # noqa: E501
- Return type
str
- property north_angle¶
Gets the north_angle of this TimeAndPlaceSunDirection. # noqa: E501
- Returns
The north_angle of this TimeAndPlaceSunDirection. # noqa: E501
- Return type
- openapi_types = {'geographical_location': 'GeographicalLocation', 'local_date_time': 'str', 'north_angle': 'DimensionalAngle', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TimeAndPlaceSunDirection. # noqa: E501
Schema name: TimeAndPlaceSunDirection # noqa: E501
- Returns
The type of this TimeAndPlaceSunDirection. # noqa: E501
- Return type
str
simscale_sdk.models.time_differentiation_schemes module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.time_differentiation_schemes.TimeDifferentiationSchemes(for_default=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'for_default': 'forDefault'}¶
- property for_default¶
Gets the for_default of this TimeDifferentiationSchemes. # noqa: E501
- Returns
The for_default of this TimeDifferentiationSchemes. # noqa: E501
- Return type
OneOfTimeDifferentiationSchemesForDefault
- openapi_types = {'for_default': 'OneOfTimeDifferentiationSchemesForDefault'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.time_hardening_creep_formulation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.time_hardening_creep_formulation.TimeHardeningCreepFormulation(type='TIME_HARDENING', a=None, n=None, m=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property a¶
Gets the a of this TimeHardeningCreepFormulation. # noqa: E501
- Returns
The a of this TimeHardeningCreepFormulation. # noqa: E501
- Return type
- attribute_map = {'a': 'a', 'm': 'm', 'n': 'n', 'type': 'type'}¶
- property m¶
Gets the m of this TimeHardeningCreepFormulation. # noqa: E501
<p>Define the parameter <b>m</b> of the Time Hardening creep formulation: <ul><b>ε̇ = A*σ<sup>n</sup>*t<sup>m</sup></b></ul></p> # noqa: E501
- Returns
The m of this TimeHardeningCreepFormulation. # noqa: E501
- Return type
float
- property n¶
Gets the n of this TimeHardeningCreepFormulation. # noqa: E501
<p>Define the parameter <b>n</b> of the Time Hardening creep formulation: <ul><b>ε̇ = A*σ<sup>n</sup>*t<sup>m</sup></b></ul></p> # noqa: E501
- Returns
The n of this TimeHardeningCreepFormulation. # noqa: E501
- Return type
float
- openapi_types = {'a': 'DimensionalStrainRate', 'm': 'float', 'n': 'float', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TimeHardeningCreepFormulation. # noqa: E501
<p>Define the Creep formulation. Two fundamental Creep law types are available: <ul><li><b>Power Law</b></li><b>ε̇ = m*A*σ<sup>n</sup>*t<sup>m-1</sup></b><li><b>Hyperbolic Sine Law</b> </li><b>ε̇= ε<sub>0</sub>* sinh(σ/(σ<sub>0</sub>))<sup>n</sup></b>.</ul> For the Power Law different formulations, like the <b>Norton</b>, <b>Strain Hardening</b> or <b>Time Hardening</b> are available. For the Hyperbolic Sine Law, the <b>Garofalo<b> formulation is available.</p> Schema name: TimeHardeningCreepFormulation # noqa: E501
- Returns
The type of this TimeHardeningCreepFormulation. # noqa: E501
- Return type
str
simscale_sdk.models.time_step_animation_output_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.time_step_animation_output_settings.TimeStepAnimationOutputSettings(name=None, format='GIF', resolution=None, frame_rate=20, show_legend=True, show_cube=True, background_color=None, type='TIME_STEP', from_frame_index=0, to_frame_index=None, skip_frames=0, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'background_color': 'backgroundColor', 'format': 'format', 'frame_rate': 'frameRate', 'from_frame_index': 'fromFrameIndex', 'name': 'name', 'resolution': 'resolution', 'show_cube': 'showCube', 'show_legend': 'showLegend', 'skip_frames': 'skipFrames', 'to_frame_index': 'toFrameIndex', 'type': 'type'}¶
- property background_color¶
Gets the background_color of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The background_color of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
- property format¶
Gets the format of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The format of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
str
- property frame_rate¶
Gets the frame_rate of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The frame_rate of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
int
- property from_frame_index¶
Gets the from_frame_index of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The from_frame_index of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
int
- property name¶
Gets the name of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The name of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
str
- openapi_types = {'background_color': 'Color', 'format': 'str', 'frame_rate': 'int', 'from_frame_index': 'int', 'name': 'str', 'resolution': 'ResolutionInfo', 'show_cube': 'bool', 'show_legend': 'bool', 'skip_frames': 'int', 'to_frame_index': 'int', 'type': 'str'}¶
- property resolution¶
Gets the resolution of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The resolution of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
- property show_cube¶
Gets the show_cube of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The show_cube of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
bool
- property show_legend¶
Gets the show_legend of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The show_legend of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
bool
- property skip_frames¶
Gets the skip_frames of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The skip_frames of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- property to_frame_index¶
Gets the to_frame_index of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The to_frame_index of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
int
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TimeStepAnimationOutputSettings. # noqa: E501
- Returns
The type of this TimeStepAnimationOutputSettings. # noqa: E501
- Return type
str
simscale_sdk.models.time_step_animation_output_settings_all_of module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.time_step_animation_output_settings_all_of.TimeStepAnimationOutputSettingsAllOf(type='TIME_STEP', from_frame_index=0, to_frame_index=None, skip_frames=0, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'from_frame_index': 'fromFrameIndex', 'skip_frames': 'skipFrames', 'to_frame_index': 'toFrameIndex', 'type': 'type'}¶
- property from_frame_index¶
Gets the from_frame_index of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The from_frame_index of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- openapi_types = {'from_frame_index': 'int', 'skip_frames': 'int', 'to_frame_index': 'int', 'type': 'str'}¶
- property skip_frames¶
Gets the skip_frames of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The skip_frames of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- to_dict()¶
Returns the model properties as a dict
- property to_frame_index¶
Gets the to_frame_index of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The to_frame_index of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Return type
int
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Returns
The type of this TimeStepAnimationOutputSettingsAllOf. # noqa: E501
- Return type
str
simscale_sdk.models.time_step_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.time_step_write_control.TimeStepWriteControl(type='TIME_STEP', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TimeStepWriteControl. # noqa: E501
This option controls how the simulation results are written and how frequently. Schema name: TimeStepWriteControl # noqa: E501
- Returns
The type of this TimeStepWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this TimeStepWriteControl. # noqa: E501
Specify an interval value that defines the number of time steps between two writes of the result. # noqa: E501
- Returns
The write_interval of this TimeStepWriteControl. # noqa: E501
- Return type
int
simscale_sdk.models.tolerance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.tolerance.Tolerance(absolute_tolerance=None, relative_tolerance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property absolute_tolerance¶
Gets the absolute_tolerance of this Tolerance. # noqa: E501
Absolute tolerance is the measure of residual in the solution after the current iteration is solved. The solution is stopped when the absolute residual falls below this value. # noqa: E501
- Returns
The absolute_tolerance of this Tolerance. # noqa: E501
- Return type
float
- attribute_map = {'absolute_tolerance': 'absoluteTolerance', 'relative_tolerance': 'relativeTolerance'}¶
- openapi_types = {'absolute_tolerance': 'float', 'relative_tolerance': 'float'}¶
- property relative_tolerance¶
Gets the relative_tolerance of this Tolerance. # noqa: E501
Relative tolerance is the ratio of current residual to the initial residual. The solution is stopped when the relative residual falls below this value. # noqa: E501
- Returns
The relative_tolerance of this Tolerance. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.top_view_predefined_camera_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.top_view_predefined_camera_settings.TopViewPredefinedCameraSettings(setting_type='TOP_VIEW', projection_type=None, direction_specifier=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'direction_specifier': 'directionSpecifier', 'projection_type': 'projectionType', 'setting_type': 'settingType'}¶
- property direction_specifier¶
Gets the direction_specifier of this TopViewPredefinedCameraSettings. # noqa: E501
- Returns
The direction_specifier of this TopViewPredefinedCameraSettings. # noqa: E501
- Return type
str
- openapi_types = {'direction_specifier': 'str', 'projection_type': 'ProjectionType', 'setting_type': 'str'}¶
- property projection_type¶
Gets the projection_type of this TopViewPredefinedCameraSettings. # noqa: E501
- Returns
The projection_type of this TopViewPredefinedCameraSettings. # noqa: E501
- Return type
- property setting_type¶
Gets the setting_type of this TopViewPredefinedCameraSettings. # noqa: E501
- Returns
The setting_type of this TopViewPredefinedCameraSettings. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.topological_reference module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.topological_reference.TopologicalReference(entities=None, sets=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'entities': 'entities', 'sets': 'sets'}¶
- property entities¶
Gets the entities of this TopologicalReference. # noqa: E501
- Returns
The entities of this TopologicalReference. # noqa: E501
- Return type
list[str]
- openapi_types = {'entities': 'list[str]', 'sets': 'list[str]'}¶
- property sets¶
Gets the sets of this TopologicalReference. # noqa: E501
- Returns
The sets of this TopologicalReference. # noqa: E501
- Return type
list[str]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.total_equivalent_plastic_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_equivalent_plastic_strain_type.TotalEquivalentPlasticStrainType(type='TOTAL_EQUI_PLASTIC', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TotalEquivalentPlasticStrainType. # noqa: E501
Schema name: TotalEquivalentPlasticStrainType # noqa: E501
- Returns
The type of this TotalEquivalentPlasticStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.total_isotropic_stiffness_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_isotropic_stiffness_definition.TotalIsotropicStiffnessDefinition(type='TOTAL_ISOTROPIC', total=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'total': 'total', 'type': 'type'}¶
- openapi_types = {'total': 'DimensionalSurfaceTension', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total¶
Gets the total of this TotalIsotropicStiffnessDefinition. # noqa: E501
- Returns
The total of this TotalIsotropicStiffnessDefinition. # noqa: E501
- Return type
- property type¶
Gets the type of this TotalIsotropicStiffnessDefinition. # noqa: E501
Schema name: TotalIsotropicStiffnessDefinition # noqa: E501
- Returns
The type of this TotalIsotropicStiffnessDefinition. # noqa: E501
- Return type
str
simscale_sdk.models.total_linear_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_linear_strain_type.TotalLinearStrainType(type='TOTAL_LINEAR', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this TotalLinearStrainType. # noqa: E501
- Returns
The component_selection of this TotalLinearStrainType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TotalLinearStrainType. # noqa: E501
Schema name: TotalLinearStrainType # noqa: E501
- Returns
The type of this TotalLinearStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.total_non_linear_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_non_linear_strain_type.TotalNonLinearStrainType(type='TOTAL_NONLINEAR', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this TotalNonLinearStrainType. # noqa: E501
- Returns
The component_selection of this TotalNonLinearStrainType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TotalNonLinearStrainType. # noqa: E501
Schema name: TotalNonLinearStrainType # noqa: E501
- Returns
The type of this TotalNonLinearStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.total_orthotropic_stiffness_definition module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_orthotropic_stiffness_definition.TotalOrthotropicStiffnessDefinition(type='TOTAL_ORTHOTROPIC', total=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'total': 'total', 'type': 'type'}¶
- openapi_types = {'total': 'DimensionalVectorSurfaceTension', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total¶
Gets the total of this TotalOrthotropicStiffnessDefinition. # noqa: E501
- Returns
The total of this TotalOrthotropicStiffnessDefinition. # noqa: E501
- Return type
- property type¶
Gets the type of this TotalOrthotropicStiffnessDefinition. # noqa: E501
Schema name: TotalOrthotropicStiffnessDefinition # noqa: E501
- Returns
The type of this TotalOrthotropicStiffnessDefinition. # noqa: E501
- Return type
str
simscale_sdk.models.total_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_pbc.TotalPBC(type='TOTAL_PRESSURE', total_pressure=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'total_pressure': 'totalPressure', 'type': 'type'}¶
- openapi_types = {'total_pressure': 'DimensionalFunctionPressure', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total_pressure¶
Gets the total_pressure of this TotalPBC. # noqa: E501
- Returns
The total_pressure of this TotalPBC. # noqa: E501
- Return type
- property type¶
Gets the type of this TotalPBC. # noqa: E501
Schema name: TotalPBC # noqa: E501
- Returns
The type of this TotalPBC. # noqa: E501
- Return type
str
simscale_sdk.models.total_pressure_pressure_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_pressure_pressure_type.TotalPressurePressureType(type='TOTAL_PRESSURE', pressure_value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'pressure_value': 'pressureValue', 'type': 'type'}¶
- openapi_types = {'pressure_value': 'DimensionalPressure', 'type': 'str'}¶
- property pressure_value¶
Gets the pressure_value of this TotalPressurePressureType. # noqa: E501
- Returns
The pressure_value of this TotalPressurePressureType. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TotalPressurePressureType. # noqa: E501
Schema name: TotalPressurePressureType # noqa: E501
- Returns
The type of this TotalPressurePressureType. # noqa: E501
- Return type
str
simscale_sdk.models.total_resistance_interface_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_resistance_interface_thermal.TotalResistanceInterfaceThermal(type='TOTAL_RESISTANCE', contact_resistance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_resistance': 'contactResistance', 'type': 'type'}¶
- property contact_resistance¶
Gets the contact_resistance of this TotalResistanceInterfaceThermal. # noqa: E501
- Returns
The contact_resistance of this TotalResistanceInterfaceThermal. # noqa: E501
- Return type
- openapi_types = {'contact_resistance': 'DimensionalContactResistance', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TotalResistanceInterfaceThermal. # noqa: E501
Schema name: TotalResistanceInterfaceThermal # noqa: E501
- Returns
The type of this TotalResistanceInterfaceThermal. # noqa: E501
- Return type
str
simscale_sdk.models.total_resistance_wall_thermal module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_resistance_wall_thermal.TotalResistanceWallThermal(type='TOTAL_RESISTANCE', contact_resistance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'contact_resistance': 'contactResistance', 'type': 'type'}¶
- property contact_resistance¶
Gets the contact_resistance of this TotalResistanceWallThermal. # noqa: E501
- Returns
The contact_resistance of this TotalResistanceWallThermal. # noqa: E501
- Return type
- openapi_types = {'contact_resistance': 'DimensionalContactResistance', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TotalResistanceWallThermal. # noqa: E501
Schema name: TotalResistanceWallThermal # noqa: E501
- Returns
The type of this TotalResistanceWallThermal. # noqa: E501
- Return type
str
simscale_sdk.models.total_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.total_tbc.TotalTBC(type='TOTAL_TEMPERATURE', total_temperature=None, specific_heat_ratio=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'specific_heat_ratio': 'specificHeatRatio', 'total_temperature': 'totalTemperature', 'type': 'type'}¶
- openapi_types = {'specific_heat_ratio': 'float', 'total_temperature': 'DimensionalTemperature', 'type': 'str'}¶
- property specific_heat_ratio¶
Gets the specific_heat_ratio of this TotalTBC. # noqa: E501
- Returns
The specific_heat_ratio of this TotalTBC. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property total_temperature¶
Gets the total_temperature of this TotalTBC. # noqa: E501
- Returns
The total_temperature of this TotalTBC. # noqa: E501
- Return type
- property type¶
Gets the type of this TotalTBC. # noqa: E501
Schema name: TotalTBC # noqa: E501
- Returns
The type of this TotalTBC. # noqa: E501
- Return type
str
simscale_sdk.models.transient_result_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.transient_result_control.TransientResultControl(type='TRANSIENT', write_control=None, fraction_from_end=None, export_fluid=None, export_surface=None, topological_reference=None, geometry_primitive_uuids=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'export_fluid': 'exportFluid', 'export_surface': 'exportSurface', 'fraction_from_end': 'fractionFromEnd', 'geometry_primitive_uuids': 'geometryPrimitiveUuids', 'topological_reference': 'topologicalReference', 'type': 'type', 'write_control': 'writeControl'}¶
- property export_fluid¶
Gets the export_fluid of this TransientResultControl. # noqa: E501
When this switch is activated, simulation data of the flow-field enclosed in the assignments will be exported # noqa: E501
- Returns
The export_fluid of this TransientResultControl. # noqa: E501
- Return type
bool
- property export_surface¶
Gets the export_surface of this TransientResultControl. # noqa: E501
When this switch is activated, simulation data on all surfaces enclosed in the assignments will be exported # noqa: E501
- Returns
The export_surface of this TransientResultControl. # noqa: E501
- Return type
bool
- property fraction_from_end¶
Gets the fraction_from_end of this TransientResultControl. # noqa: E501
It defines the point in simulation where the result output data extraction starts. For instance, <i>Fraction from end</i> of 1 (100%) extracts all data from the beginning of the simulation while default 0.2 extracts 20% data from the end of the simulation. # noqa: E501
- Returns
The fraction_from_end of this TransientResultControl. # noqa: E501
- Return type
float
- property geometry_primitive_uuids¶
Gets the geometry_primitive_uuids of this TransientResultControl. # noqa: E501
- Returns
The geometry_primitive_uuids of this TransientResultControl. # noqa: E501
- Return type
list[str]
- openapi_types = {'export_fluid': 'bool', 'export_surface': 'bool', 'fraction_from_end': 'float', 'geometry_primitive_uuids': 'list[str]', 'topological_reference': 'TopologicalReference', 'type': 'str', 'write_control': 'OneOfTransientResultControlWriteControl'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this TransientResultControl. # noqa: E501
- Returns
The topological_reference of this TransientResultControl. # noqa: E501
- Return type
- property type¶
Gets the type of this TransientResultControl. # noqa: E501
Schema name: TransientResultControl # noqa: E501
- Returns
The type of this TransientResultControl. # noqa: E501
- Return type
str
- property write_control¶
Gets the write_control of this TransientResultControl. # noqa: E501
- Returns
The write_control of this TransientResultControl. # noqa: E501
- Return type
OneOfTransientResultControlWriteControl
simscale_sdk.models.transient_time_dependency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.transient_time_dependency.TransientTimeDependency(type='TRANSIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TransientTimeDependency. # noqa: E501
Schema name: TransientTimeDependency # noqa: E501
- Returns
The type of this TransientTimeDependency. # noqa: E501
- Return type
str
simscale_sdk.models.tresca_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.tresca_stress_type.TrescaStressType(type='TRESCA', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TrescaStressType. # noqa: E501
Schema name: TrescaStressType # noqa: E501
- Returns
The type of this TrescaStressType. # noqa: E501
- Return type
str
simscale_sdk.models.true_change_jacobian_matrix module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.true_change_jacobian_matrix.TrueChangeJacobianMatrix(type='TRUE', threshold_time_step_value=None, matrix_reactualization_iteration=None, max_newton_iterations=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'matrix_reactualization_iteration': 'matrixReactualizationIteration', 'max_newton_iterations': 'maxNewtonIterations', 'threshold_time_step_value': 'thresholdTimeStepValue', 'type': 'type'}¶
- property matrix_reactualization_iteration¶
Gets the matrix_reactualization_iteration of this TrueChangeJacobianMatrix. # noqa: E501
<p>Set how often the elastic stiffness matrix should be recomputed. If this parameter is set to 10, the elastic matrix is recomputed every 10th iteration within a given time step. If it is set to 0, the elastic stiffness matrix is not updated within any time step.</p> # noqa: E501
- Returns
The matrix_reactualization_iteration of this TrueChangeJacobianMatrix. # noqa: E501
- Return type
int
- property max_newton_iterations¶
Gets the max_newton_iterations of this TrueChangeJacobianMatrix. # noqa: E501
<p>Maximum number of allowed Newton iterations per time increment. If this value is reached the simulation is considered non-converging. If an automatic time stepping is activated the time increment is reduced in order to reach convergence.</p> # noqa: E501
- Returns
The max_newton_iterations of this TrueChangeJacobianMatrix. # noqa: E501
- Return type
int
- openapi_types = {'matrix_reactualization_iteration': 'int', 'max_newton_iterations': 'int', 'threshold_time_step_value': 'float', 'type': 'str'}¶
- property threshold_time_step_value¶
Gets the threshold_time_step_value of this TrueChangeJacobianMatrix. # noqa: E501
<p>Set the threshold value of the Jacobian matrix changing. If the time increment is lower than this value the elastic matrix is used.</p> # noqa: E501
- Returns
The threshold_time_step_value of this TrueChangeJacobianMatrix. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TrueChangeJacobianMatrix. # noqa: E501
<p>Choose if the Jacobian matrix should automatically change from tangent stiffnes matrix to elastic matrix if the time increment is falling below a given threshold. On the assumption that below a given time increment value the nonlinearities are not evolving within the time step one can strongly save computation time by switching to the elastic matrix.</p> Schema name: TrueChangeJacobianMatrix # noqa: E501
- Returns
The type of this TrueChangeJacobianMatrix. # noqa: E501
- Return type
str
simscale_sdk.models.true_line_search module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.true_line_search.TrueLineSearch(type='TRUE', method=None, residual=None, max_iterations=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_iterations': 'maxIterations', 'method': 'method', 'residual': 'residual', 'type': 'type'}¶
- property max_iterations¶
Gets the max_iterations of this TrueLineSearch. # noqa: E501
<p>Set the maximum number for line search iterations. Typically a sinlge-digit number should be sufficient.</p> # noqa: E501
- Returns
The max_iterations of this TrueLineSearch. # noqa: E501
- Return type
int
- property method¶
Gets the method of this TrueLineSearch. # noqa: E501
<p>Choose the method of the line search algorithm. The <b>Secant method</b> is a simple one dimensional search algorithm. The <b>mixed method</b> is a more elaborate algorithm that uses variable bounds.</p> # noqa: E501
- Returns
The method of this TrueLineSearch. # noqa: E501
- Return type
str
- openapi_types = {'max_iterations': 'int', 'method': 'str', 'residual': 'float', 'type': 'str'}¶
- property residual¶
Gets the residual of this TrueLineSearch. # noqa: E501
<p>Set the residual for the line search convergence</p> # noqa: E501
- Returns
The residual of this TrueLineSearch. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TrueLineSearch. # noqa: E501
<p>Line search can be used to improve convergence for nonlinear calculations with the Newton method.</p> Schema name: TrueLineSearch # noqa: E501
- Returns
The type of this TrueLineSearch. # noqa: E501
- Return type
str
simscale_sdk.models.true_semi_implicit module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.true_semi_implicit.TrueSemiImplicit(type='TRUE_SEMI_IMPLICIT', limiter_iterations=None, compression_correction=None, solver=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'compression_correction': 'compressionCorrection', 'limiter_iterations': 'limiterIterations', 'solver': 'solver', 'type': 'type'}¶
- property compression_correction¶
Gets the compression_correction of this TrueSemiImplicit. # noqa: E501
- Returns
The compression_correction of this TrueSemiImplicit. # noqa: E501
- Return type
bool
- property limiter_iterations¶
Gets the limiter_iterations of this TrueSemiImplicit. # noqa: E501
- Returns
The limiter_iterations of this TrueSemiImplicit. # noqa: E501
- Return type
int
- openapi_types = {'compression_correction': 'bool', 'limiter_iterations': 'int', 'solver': 'OneOfTrueSemiImplicitSolver', 'type': 'str'}¶
- property solver¶
Gets the solver of this TrueSemiImplicit. # noqa: E501
- Returns
The solver of this TrueSemiImplicit. # noqa: E501
- Return type
OneOfTrueSemiImplicitSolver
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TrueSemiImplicit. # noqa: E501
Schema name: TrueSemiImplicit # noqa: E501
- Returns
The type of this TrueSemiImplicit. # noqa: E501
- Return type
str
simscale_sdk.models.turbulence_intensity_tibc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.turbulence_intensity_tibc.TurbulenceIntensityTIBC(type='FIXED_VALUE', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionDimensionless'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TurbulenceIntensityTIBC. # noqa: E501
Schema name: TurbulenceIntensityTIBC # noqa: E501
- Returns
The type of this TurbulenceIntensityTIBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this TurbulenceIntensityTIBC. # noqa: E501
- Returns
The value of this TurbulenceIntensityTIBC. # noqa: E501
- Return type
simscale_sdk.models.turbulence_kinetic_energy_tibc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.turbulence_kinetic_energy_tibc.TurbulenceKineticEnergyTIBC(type='TURBULENCE_KINETIC_ENERGY', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionTurbulenceKineticEnergy'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TurbulenceKineticEnergyTIBC. # noqa: E501
Schema name: TurbulenceKineticEnergyTIBC # noqa: E501
- Returns
The type of this TurbulenceKineticEnergyTIBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this TurbulenceKineticEnergyTIBC. # noqa: E501
- Returns
The value of this TurbulenceKineticEnergyTIBC. # noqa: E501
- Return type
simscale_sdk.models.turbulent_dfsem_inlet_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.turbulent_dfsem_inlet_vbc.TurbulentDFSEMInletVBC(type='TURBULENT_DFSEM_INLET', domain_length_scale=None, eddy_length_scale=None, velocity=None, reynolds_stress_tensor=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'domain_length_scale': 'domainLengthScale', 'eddy_length_scale': 'eddyLengthScale', 'reynolds_stress_tensor': 'reynoldsStressTensor', 'type': 'type', 'velocity': 'velocity'}¶
- property domain_length_scale¶
Gets the domain_length_scale of this TurbulentDFSEMInletVBC. # noqa: E501
- Returns
The domain_length_scale of this TurbulentDFSEMInletVBC. # noqa: E501
- Return type
- property eddy_length_scale¶
Gets the eddy_length_scale of this TurbulentDFSEMInletVBC. # noqa: E501
- Returns
The eddy_length_scale of this TurbulentDFSEMInletVBC. # noqa: E501
- Return type
- openapi_types = {'domain_length_scale': 'DimensionalLength', 'eddy_length_scale': 'DimensionalFunctionLength', 'reynolds_stress_tensor': 'StressTensorPressure', 'type': 'str', 'velocity': 'DimensionalVectorFunctionSpeed'}¶
- property reynolds_stress_tensor¶
Gets the reynolds_stress_tensor of this TurbulentDFSEMInletVBC. # noqa: E501
- Returns
The reynolds_stress_tensor of this TurbulentDFSEMInletVBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TurbulentDFSEMInletVBC. # noqa: E501
Schema name: TurbulentDFSEMInletVBC # noqa: E501
- Returns
The type of this TurbulentDFSEMInletVBC. # noqa: E501
- Return type
str
- property velocity¶
Gets the velocity of this TurbulentDFSEMInletVBC. # noqa: E501
- Returns
The velocity of this TurbulentDFSEMInletVBC. # noqa: E501
- Return type
simscale_sdk.models.turbulent_heat_flux_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.turbulent_heat_flux_tbc.TurbulentHeatFluxTBC(type='TURBULENT_HEAT_FLUX_TEMPERATURE', heat_source=None, value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heat_source': 'heatSource', 'type': 'type', 'value': 'value'}¶
- property heat_source¶
Gets the heat_source of this TurbulentHeatFluxTBC. # noqa: E501
- Returns
The heat_source of this TurbulentHeatFluxTBC. # noqa: E501
- Return type
OneOfTurbulentHeatFluxTBCHeatSource
- openapi_types = {'heat_source': 'OneOfTurbulentHeatFluxTBCHeatSource', 'type': 'str', 'value': 'DimensionalTemperature'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this TurbulentHeatFluxTBC. # noqa: E501
Schema name: TurbulentHeatFluxTBC # noqa: E501
- Returns
The type of this TurbulentHeatFluxTBC. # noqa: E501
- Return type
str
- property value¶
Gets the value of this TurbulentHeatFluxTBC. # noqa: E501
- Returns
The value of this TurbulentHeatFluxTBC. # noqa: E501
- Return type
simscale_sdk.models.two_resistor_network module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.two_resistor_network.TwoResistorNetwork(type='TWO_RESISTOR_NETWORK', name=None, resistance_top=None, resistance_bottom=None, resistance_interface=None, network_power=None, emissivity=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'emissivity': 'emissivity', 'name': 'name', 'network_power': 'networkPower', 'resistance_bottom': 'resistanceBottom', 'resistance_interface': 'resistanceInterface', 'resistance_top': 'resistanceTop', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property emissivity¶
Gets the emissivity of this TwoResistorNetwork. # noqa: E501
- Returns
The emissivity of this TwoResistorNetwork. # noqa: E501
- Return type
float
- property name¶
Gets the name of this TwoResistorNetwork. # noqa: E501
- Returns
The name of this TwoResistorNetwork. # noqa: E501
- Return type
str
- property network_power¶
Gets the network_power of this TwoResistorNetwork. # noqa: E501
- Returns
The network_power of this TwoResistorNetwork. # noqa: E501
- Return type
- openapi_types = {'emissivity': 'float', 'name': 'str', 'network_power': 'DimensionalPower', 'resistance_bottom': 'DimensionalContactResistance', 'resistance_interface': 'DimensionalContactResistance', 'resistance_top': 'DimensionalContactResistance', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property resistance_bottom¶
Gets the resistance_bottom of this TwoResistorNetwork. # noqa: E501
- Returns
The resistance_bottom of this TwoResistorNetwork. # noqa: E501
- Return type
- property resistance_interface¶
Gets the resistance_interface of this TwoResistorNetwork. # noqa: E501
- Returns
The resistance_interface of this TwoResistorNetwork. # noqa: E501
- Return type
- property resistance_top¶
Gets the resistance_top of this TwoResistorNetwork. # noqa: E501
- Returns
The resistance_top of this TwoResistorNetwork. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this TwoResistorNetwork. # noqa: E501
- Returns
The topological_reference of this TwoResistorNetwork. # noqa: E501
- Return type
- property type¶
Gets the type of this TwoResistorNetwork. # noqa: E501
<br>A <i>Thermal Resistance Network</i> can be used to approximate the effect of heat sources and heat transfer from that source to the surrounding domain without resolving the source geometry. Select the top face of the body you want to assign. <p>The models for <b>Thermal resistance network</b> are as follows:</p><ul><li><b>Star Network Resistance Model:</b> defines a thermal resistance network consisting out of a top, a board, a board to interface and four side resistances. A power source is assigned to the body.</li><li><b>Two resistor Model:</b> defines a thermal resistance network consisting out of a top, a board and a board to interface resistance. A power source is assigned to the body.</li></ul> <br> <a href=’https://www.simscale.com/docs/simulation-setup/advanced-concepts/thermal-resistance-networks/’ target=’_blank’>Learn more</a>. Schema name: TwoResistorNetwork # noqa: E501
- Returns
The type of this TwoResistorNetwork. # noqa: E501
- Return type
str
simscale_sdk.models.unconstrained_optional_function module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unconstrained_optional_function.UnconstrainedOptionalFunction(type='UNCONSTRAINED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this UnconstrainedOptionalFunction. # noqa: E501
Schema name: UnconstrainedOptionalFunction # noqa: E501
- Returns
The type of this UnconstrainedOptionalFunction. # noqa: E501
- Return type
str
simscale_sdk.models.uncorrected_surface_normal_gradient_scheme module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.uncorrected_surface_normal_gradient_scheme.UncorrectedSurfaceNormalGradientScheme(type='UNCORRECTED', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this UncorrectedSurfaceNormalGradientScheme. # noqa: E501
Schema name: UncorrectedSurfaceNormalGradientScheme # noqa: E501
- Returns
The type of this UncorrectedSurfaceNormalGradientScheme. # noqa: E501
- Return type
str
simscale_sdk.models.unelastic_strain_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unelastic_strain_type.UnelasticStrainType(type='UNELASTIC', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this UnelasticStrainType. # noqa: E501
- Returns
The component_selection of this UnelasticStrainType. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this UnelasticStrainType. # noqa: E501
Schema name: UnelasticStrainType # noqa: E501
- Returns
The type of this UnelasticStrainType. # noqa: E501
- Return type
str
simscale_sdk.models.unit_dimensionless module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_dimensionless.UnitDimensionless(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitDimensionless. # noqa: E501
- Returns
The unit of this UnitDimensionless. # noqa: E501
- Return type
str
simscale_sdk.models.unit_frequency module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_frequency.UnitFrequency(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitFrequency. # noqa: E501
- Returns
The unit of this UnitFrequency. # noqa: E501
- Return type
str
simscale_sdk.models.unit_length module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_length.UnitLength(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitLength. # noqa: E501
- Returns
The unit of this UnitLength. # noqa: E501
- Return type
str
simscale_sdk.models.unit_mass_flow_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_mass_flow_rate.UnitMassFlowRate(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitMassFlowRate. # noqa: E501
- Returns
The unit of this UnitMassFlowRate. # noqa: E501
- Return type
str
simscale_sdk.models.unit_temperature module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_temperature.UnitTemperature(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitTemperature. # noqa: E501
- Returns
The unit of this UnitTemperature. # noqa: E501
- Return type
str
simscale_sdk.models.unit_time module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_time.UnitTime(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitTime. # noqa: E501
- Returns
The unit of this UnitTime. # noqa: E501
- Return type
str
simscale_sdk.models.unit_volumetric_flow_rate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.unit_volumetric_flow_rate.UnitVolumetricFlowRate(unit=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'unit': 'unit'}¶
- openapi_types = {'unit': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property unit¶
Gets the unit of this UnitVolumetricFlowRate. # noqa: E501
- Returns
The unit of this UnitVolumetricFlowRate. # noqa: E501
- Return type
str
simscale_sdk.models.update_material_group_request module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.update_material_group_request.UpdateMaterialGroupRequest(name=None, metadata=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'metadata': 'metadata', 'name': 'name'}¶
- property metadata¶
Gets the metadata of this UpdateMaterialGroupRequest. # noqa: E501
- Returns
The metadata of this UpdateMaterialGroupRequest. # noqa: E501
- Return type
object
- property name¶
Gets the name of this UpdateMaterialGroupRequest. # noqa: E501
The name of the material group. # noqa: E501
- Returns
The name of this UpdateMaterialGroupRequest. # noqa: E501
- Return type
str
- openapi_types = {'metadata': 'object', 'name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.user_defined_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.user_defined_write_control.UserDefinedWriteControl(type='USER_DEFINED_V21', write_increment=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_increment': 'writeIncrement'}¶
- openapi_types = {'type': 'str', 'write_increment': 'RestrictedDimensionalFunctionTime'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this UserDefinedWriteControl. # noqa: E501
<p>Define how frequently intermediate results should be saved. With the selection of <b>initial time steps</b> only the user defined time steps are stored in the result and by selecting <b>all computed time steps</b> also intermediate results that were created by the automatic time stepping are saved. With the selection of <b>write interval</b> a specific write frequency can be chosen which reduces the result size. Finally using <b>user defined time steps</b> there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the <b>time step length</b> definition.</p> Schema name: UserDefinedWriteControl # noqa: E501
- Returns
The type of this UserDefinedWriteControl. # noqa: E501
- Return type
str
- property write_increment¶
Gets the write_increment of this UserDefinedWriteControl. # noqa: E501
- Returns
The write_increment of this UserDefinedWriteControl. # noqa: E501
- Return type
simscale_sdk.models.user_input_camera_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.user_input_camera_settings.UserInputCameraSettings(setting_type='USER_INPUT', projection_type=None, up=None, eye=None, center=None, front_plane_frustum_height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'center': 'center', 'eye': 'eye', 'front_plane_frustum_height': 'frontPlaneFrustumHeight', 'projection_type': 'projectionType', 'setting_type': 'settingType', 'up': 'up'}¶
- property center¶
Gets the center of this UserInputCameraSettings. # noqa: E501
- Returns
The center of this UserInputCameraSettings. # noqa: E501
- Return type
- property eye¶
Gets the eye of this UserInputCameraSettings. # noqa: E501
- Returns
The eye of this UserInputCameraSettings. # noqa: E501
- Return type
- property front_plane_frustum_height¶
Gets the front_plane_frustum_height of this UserInputCameraSettings. # noqa: E501
required only for orthogonal projection type # noqa: E501
- Returns
The front_plane_frustum_height of this UserInputCameraSettings. # noqa: E501
- Return type
float
- openapi_types = {'center': 'Vector3D', 'eye': 'Vector3D', 'front_plane_frustum_height': 'float', 'projection_type': 'ProjectionType', 'setting_type': 'str', 'up': 'Vector3D'}¶
- property projection_type¶
Gets the projection_type of this UserInputCameraSettings. # noqa: E501
- Returns
The projection_type of this UserInputCameraSettings. # noqa: E501
- Return type
- property setting_type¶
Gets the setting_type of this UserInputCameraSettings. # noqa: E501
- Returns
The setting_type of this UserInputCameraSettings. # noqa: E501
- Return type
str
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_f module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_f.VariableGroupF(f=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'f': 'F'}¶
- property f¶
Gets the f of this VariableGroupF. # noqa: E501
- Returns
The f of this VariableGroupF. # noqa: E501
- Return type
- openapi_types = {'f': 'UnitFrequency'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_height module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_height.VariableGroupHEIGHT(height=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'height': 'HEIGHT'}¶
- property height¶
Gets the height of this VariableGroupHEIGHT. # noqa: E501
- Returns
The height of this VariableGroupHEIGHT. # noqa: E501
- Return type
- openapi_types = {'height': 'UnitLength'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_q module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_q.VariableGroupQ(q=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'q': 'Q'}¶
- openapi_types = {'q': 'UnitMassFlowRate'}¶
- property q¶
Gets the q of this VariableGroupQ. # noqa: E501
- Returns
The q of this VariableGroupQ. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_strain module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_strain.VariableGroupSTRAIN(e=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'e': 'E'}¶
- property e¶
Gets the e of this VariableGroupSTRAIN. # noqa: E501
- Returns
The e of this VariableGroupSTRAIN. # noqa: E501
- Return type
- openapi_types = {'e': 'UnitDimensionless'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_temp module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_temp.VariableGroupTEMP(temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'temperature': 'Temperature'}¶
- openapi_types = {'temperature': 'UnitTemperature'}¶
- property temperature¶
Gets the temperature of this VariableGroupTEMP. # noqa: E501
- Returns
The temperature of this VariableGroupTEMP. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_tempstrain module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_tempstrain.VariableGroupTEMPSTRAIN(e=None, temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'e': 'E', 'temperature': 'Temperature'}¶
- property e¶
Gets the e of this VariableGroupTEMPSTRAIN. # noqa: E501
- Returns
The e of this VariableGroupTEMPSTRAIN. # noqa: E501
- Return type
- openapi_types = {'e': 'UnitDimensionless', 'temperature': 'UnitTemperature'}¶
- property temperature¶
Gets the temperature of this VariableGroupTEMPSTRAIN. # noqa: E501
- Returns
The temperature of this VariableGroupTEMPSTRAIN. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_time module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_time.VariableGroupTIME(t=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'t': 'T'}¶
- openapi_types = {'t': 'UnitTime'}¶
- property t¶
Gets the t of this VariableGroupTIME. # noqa: E501
- Returns
The t of this VariableGroupTIME. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.variable_group_vdot module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_vdot.VariableGroupVDOT(v_dot=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'v_dot': 'V_DOT'}¶
- openapi_types = {'v_dot': 'UnitVolumetricFlowRate'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property v_dot¶
Gets the v_dot of this VariableGroupVDOT. # noqa: E501
- Returns
The v_dot of this VariableGroupVDOT. # noqa: E501
- Return type
simscale_sdk.models.variable_group_xyz module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_xyz.VariableGroupXYZ(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'X', 'y': 'Y', 'z': 'Z'}¶
- openapi_types = {'x': 'UnitLength', 'y': 'UnitLength', 'z': 'UnitLength'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this VariableGroupXYZ. # noqa: E501
- Returns
The x of this VariableGroupXYZ. # noqa: E501
- Return type
- property y¶
Gets the y of this VariableGroupXYZ. # noqa: E501
- Returns
The y of this VariableGroupXYZ. # noqa: E501
- Return type
- property z¶
Gets the z of this VariableGroupXYZ. # noqa: E501
- Returns
The z of this VariableGroupXYZ. # noqa: E501
- Return type
simscale_sdk.models.variable_group_xyztime module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_xyztime.VariableGroupXYZTIME(x=None, y=None, z=None, t=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'t': 'T', 'x': 'X', 'y': 'Y', 'z': 'Z'}¶
- openapi_types = {'t': 'UnitTime', 'x': 'UnitLength', 'y': 'UnitLength', 'z': 'UnitLength'}¶
- property t¶
Gets the t of this VariableGroupXYZTIME. # noqa: E501
- Returns
The t of this VariableGroupXYZTIME. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this VariableGroupXYZTIME. # noqa: E501
- Returns
The x of this VariableGroupXYZTIME. # noqa: E501
- Return type
- property y¶
Gets the y of this VariableGroupXYZTIME. # noqa: E501
- Returns
The y of this VariableGroupXYZTIME. # noqa: E501
- Return type
- property z¶
Gets the z of this VariableGroupXYZTIME. # noqa: E501
- Returns
The z of this VariableGroupXYZTIME. # noqa: E501
- Return type
simscale_sdk.models.variable_group_xyztimetemp module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.variable_group_xyztimetemp.VariableGroupXYZTIMETEMP(x=None, y=None, z=None, t=None, temperature=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'t': 'T', 'temperature': 'Temperature', 'x': 'X', 'y': 'Y', 'z': 'Z'}¶
- openapi_types = {'t': 'UnitTime', 'temperature': 'UnitTemperature', 'x': 'UnitLength', 'y': 'UnitLength', 'z': 'UnitLength'}¶
- property t¶
Gets the t of this VariableGroupXYZTIMETEMP. # noqa: E501
- Returns
The t of this VariableGroupXYZTIMETEMP. # noqa: E501
- Return type
- property temperature¶
Gets the temperature of this VariableGroupXYZTIMETEMP. # noqa: E501
- Returns
The temperature of this VariableGroupXYZTIMETEMP. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this VariableGroupXYZTIMETEMP. # noqa: E501
- Returns
The x of this VariableGroupXYZTIMETEMP. # noqa: E501
- Return type
- property y¶
Gets the y of this VariableGroupXYZTIMETEMP. # noqa: E501
- Returns
The y of this VariableGroupXYZTIMETEMP. # noqa: E501
- Return type
- property z¶
Gets the z of this VariableGroupXYZTIMETEMP. # noqa: E501
- Returns
The z of this VariableGroupXYZTIMETEMP. # noqa: E501
- Return type
simscale_sdk.models.vector3_d module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.vector3_d.Vector3D(x=None, y=None, z=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'x': 'x', 'y': 'y', 'z': 'z'}¶
- openapi_types = {'x': 'float', 'y': 'float', 'z': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property x¶
Gets the x of this Vector3D. # noqa: E501
- Returns
The x of this Vector3D. # noqa: E501
- Return type
float
- property y¶
Gets the y of this Vector3D. # noqa: E501
- Returns
The y of this Vector3D. # noqa: E501
- Return type
float
- property z¶
Gets the z of this Vector3D. # noqa: E501
- Returns
The z of this Vector3D. # noqa: E501
- Return type
float
simscale_sdk.models.vector_field module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.vector_field.VectorField(field_name=None, data_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'data_type': 'dataType', 'field_name': 'fieldName'}¶
- property data_type¶
Gets the data_type of this VectorField. # noqa: E501
- Returns
The data_type of this VectorField. # noqa: E501
- Return type
- property field_name¶
Gets the field_name of this VectorField. # noqa: E501
- Returns
The field_name of this VectorField. # noqa: E501
- Return type
str
- openapi_types = {'data_type': 'DataType', 'field_name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.vector_rotation module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.vector_rotation.VectorRotation(type='VECTOR_ROTATION', rotation_center=None, angular_velocity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property angular_velocity¶
Gets the angular_velocity of this VectorRotation. # noqa: E501
- Returns
The angular_velocity of this VectorRotation. # noqa: E501
- Return type
- attribute_map = {'angular_velocity': 'angularVelocity', 'rotation_center': 'rotationCenter', 'type': 'type'}¶
- openapi_types = {'angular_velocity': 'DimensionalVectorRotationSpeed', 'rotation_center': 'DimensionalVectorLength', 'type': 'str'}¶
- property rotation_center¶
Gets the rotation_center of this VectorRotation. # noqa: E501
- Returns
The rotation_center of this VectorRotation. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this VectorRotation. # noqa: E501
Schema name: VectorRotation # noqa: E501
- Returns
The type of this VectorRotation. # noqa: E501
- Return type
str
simscale_sdk.models.vector_settings module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.vector_settings.VectorSettings(vector_field=None, scale_factor=0.2, solid_color=None, coloring='BY_VECTOR_FIELD', minimum_clamping_range=None, maximum_clamping_range=None, minimum_filtering_range=None, maximum_filtering_range=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'coloring': 'coloring', 'maximum_clamping_range': 'maximumClampingRange', 'maximum_filtering_range': 'maximumFilteringRange', 'minimum_clamping_range': 'minimumClampingRange', 'minimum_filtering_range': 'minimumFilteringRange', 'scale_factor': 'scaleFactor', 'solid_color': 'solidColor', 'vector_field': 'vectorField'}¶
- property coloring¶
Gets the coloring of this VectorSettings. # noqa: E501
- Returns
The coloring of this VectorSettings. # noqa: E501
- Return type
str
- property maximum_clamping_range¶
Gets the maximum_clamping_range of this VectorSettings. # noqa: E501
The maximum length of (non-zero) vectors will be drawn as. Must not be smaller than minimumClampingRange. Default value is the maximum length of the specified vector field. # noqa: E501
- Returns
The maximum_clamping_range of this VectorSettings. # noqa: E501
- Return type
float
- property maximum_filtering_range¶
Gets the maximum_filtering_range of this VectorSettings. # noqa: E501
The required maximum length of the vectors in order to be drawn. Must not be smaller than minimumFilteringRange. Default value is the maximum length of the specified vector field. # noqa: E501
- Returns
The maximum_filtering_range of this VectorSettings. # noqa: E501
- Return type
float
- property minimum_clamping_range¶
Gets the minimum_clamping_range of this VectorSettings. # noqa: E501
The minimum length of (non-zero) vectors will be drawn as. Must not be larger than maximumClampingRange. Default value is the minimum length of the specified vector field. # noqa: E501
- Returns
The minimum_clamping_range of this VectorSettings. # noqa: E501
- Return type
float
- property minimum_filtering_range¶
Gets the minimum_filtering_range of this VectorSettings. # noqa: E501
The required minimum length of the vectors in order to be drawn. Must not be larger than maximumFilteringRange. Default value is the minimum length of the specified vector field. # noqa: E501
- Returns
The minimum_filtering_range of this VectorSettings. # noqa: E501
- Return type
float
- openapi_types = {'coloring': 'str', 'maximum_clamping_range': 'float', 'maximum_filtering_range': 'float', 'minimum_clamping_range': 'float', 'minimum_filtering_range': 'float', 'scale_factor': 'float', 'solid_color': 'Color', 'vector_field': 'VectorField'}¶
- property scale_factor¶
Gets the scale_factor of this VectorSettings. # noqa: E501
- Returns
The scale_factor of this VectorSettings. # noqa: E501
- Return type
float
- property solid_color¶
Gets the solid_color of this VectorSettings. # noqa: E501
- Returns
The solid_color of this VectorSettings. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property vector_field¶
Gets the vector_field of this VectorSettings. # noqa: E501
- Returns
The vector_field of this VectorSettings. # noqa: E501
- Return type
simscale_sdk.models.velocity_field_selection module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.velocity_field_selection.VelocityFieldSelection(type='VELOCITY', component_selection=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'component_selection': 'componentSelection', 'type': 'type'}¶
- property component_selection¶
Gets the component_selection of this VelocityFieldSelection. # noqa: E501
- Returns
The component_selection of this VelocityFieldSelection. # noqa: E501
- Return type
str
- openapi_types = {'component_selection': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this VelocityFieldSelection. # noqa: E501
Schema name: VelocityFieldSelection # noqa: E501
- Returns
The type of this VelocityFieldSelection. # noqa: E501
- Return type
str
simscale_sdk.models.velocity_inlet_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.velocity_inlet_bc.VelocityInletBC(type='VELOCITY_INLET_V3', name=None, velocity=None, temperature=None, passive_scalars=None, phase_fraction=None, turbulence_intensity=None, dissipation_type=None, net_radiative_heat_flux=None, radiative_intensity_ray=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'dissipation_type': 'dissipationType', 'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'passive_scalars': 'passiveScalars', 'phase_fraction': 'phaseFraction', 'radiative_intensity_ray': 'radiativeIntensityRay', 'temperature': 'temperature', 'topological_reference': 'topologicalReference', 'turbulence_intensity': 'turbulenceIntensity', 'type': 'type', 'velocity': 'velocity'}¶
- property dissipation_type¶
Gets the dissipation_type of this VelocityInletBC. # noqa: E501
- Returns
The dissipation_type of this VelocityInletBC. # noqa: E501
- Return type
OneOfVelocityInletBCDissipationType
- property name¶
Gets the name of this VelocityInletBC. # noqa: E501
- Returns
The name of this VelocityInletBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this VelocityInletBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this VelocityInletBC. # noqa: E501
- Return type
OneOfVelocityInletBCNetRadiativeHeatFlux
- openapi_types = {'dissipation_type': 'OneOfVelocityInletBCDissipationType', 'name': 'str', 'net_radiative_heat_flux': 'OneOfVelocityInletBCNetRadiativeHeatFlux', 'passive_scalars': 'list[FixedValuePSBC]', 'phase_fraction': 'FixedValuePFBC', 'radiative_intensity_ray': 'OneOfVelocityInletBCRadiativeIntensityRay', 'temperature': 'OneOfVelocityInletBCTemperature', 'topological_reference': 'TopologicalReference', 'turbulence_intensity': 'OneOfVelocityInletBCTurbulenceIntensity', 'type': 'str', 'velocity': 'OneOfVelocityInletBCVelocity'}¶
- property passive_scalars¶
Gets the passive_scalars of this VelocityInletBC. # noqa: E501
Please choose a boundary condition for passive scalar (T). # noqa: E501
- Returns
The passive_scalars of this VelocityInletBC. # noqa: E501
- Return type
list[FixedValuePSBC]
- property phase_fraction¶
Gets the phase_fraction of this VelocityInletBC. # noqa: E501
- Returns
The phase_fraction of this VelocityInletBC. # noqa: E501
- Return type
- property radiative_intensity_ray¶
Gets the radiative_intensity_ray of this VelocityInletBC. # noqa: E501
- Returns
The radiative_intensity_ray of this VelocityInletBC. # noqa: E501
- Return type
OneOfVelocityInletBCRadiativeIntensityRay
- property temperature¶
Gets the temperature of this VelocityInletBC. # noqa: E501
- Returns
The temperature of this VelocityInletBC. # noqa: E501
- Return type
OneOfVelocityInletBCTemperature
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this VelocityInletBC. # noqa: E501
- Returns
The topological_reference of this VelocityInletBC. # noqa: E501
- Return type
- property turbulence_intensity¶
Gets the turbulence_intensity of this VelocityInletBC. # noqa: E501
- Returns
The turbulence_intensity of this VelocityInletBC. # noqa: E501
- Return type
OneOfVelocityInletBCTurbulenceIntensity
- property type¶
Gets the type of this VelocityInletBC. # noqa: E501
This boundary condition imposes a known <b>velocity</b>-based constraint at an inlet. Schema name: VelocityInletBC # noqa: E501
- Returns
The type of this VelocityInletBC. # noqa: E501
- Return type
str
- property velocity¶
Gets the velocity of this VelocityInletBC. # noqa: E501
- Returns
The velocity of this VelocityInletBC. # noqa: E501
- Return type
OneOfVelocityInletBCVelocity
simscale_sdk.models.velocity_outlet_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.velocity_outlet_bc.VelocityOutletBC(type='VELOCITY_OUTLET_V7', name=None, velocity=None, phase_fraction=None, net_radiative_heat_flux=None, radiative_intensity_ray=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'phase_fraction': 'phaseFraction', 'radiative_intensity_ray': 'radiativeIntensityRay', 'topological_reference': 'topologicalReference', 'type': 'type', 'velocity': 'velocity'}¶
- property name¶
Gets the name of this VelocityOutletBC. # noqa: E501
- Returns
The name of this VelocityOutletBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this VelocityOutletBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this VelocityOutletBC. # noqa: E501
- Return type
OneOfVelocityOutletBCNetRadiativeHeatFlux
- openapi_types = {'name': 'str', 'net_radiative_heat_flux': 'OneOfVelocityOutletBCNetRadiativeHeatFlux', 'phase_fraction': 'OneOfVelocityOutletBCPhaseFraction', 'radiative_intensity_ray': 'OneOfVelocityOutletBCRadiativeIntensityRay', 'topological_reference': 'TopologicalReference', 'type': 'str', 'velocity': 'OneOfVelocityOutletBCVelocity'}¶
- property phase_fraction¶
Gets the phase_fraction of this VelocityOutletBC. # noqa: E501
- Returns
The phase_fraction of this VelocityOutletBC. # noqa: E501
- Return type
OneOfVelocityOutletBCPhaseFraction
- property radiative_intensity_ray¶
Gets the radiative_intensity_ray of this VelocityOutletBC. # noqa: E501
- Returns
The radiative_intensity_ray of this VelocityOutletBC. # noqa: E501
- Return type
OneOfVelocityOutletBCRadiativeIntensityRay
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this VelocityOutletBC. # noqa: E501
- Returns
The topological_reference of this VelocityOutletBC. # noqa: E501
- Return type
- property type¶
Gets the type of this VelocityOutletBC. # noqa: E501
This boundary condition imposes a known <b>velocity</b>-based constraint at an outlet. Schema name: VelocityOutletBC # noqa: E501
- Returns
The type of this VelocityOutletBC. # noqa: E501
- Return type
str
- property velocity¶
Gets the velocity of this VelocityOutletBC. # noqa: E501
- Returns
The velocity of this VelocityOutletBC. # noqa: E501
- Return type
OneOfVelocityOutletBCVelocity
simscale_sdk.models.velocity_result_control_item module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.velocity_result_control_item.VelocityResultControlItem(type='VELOCITY', name=None, velocity_type=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'type': 'type', 'velocity_type': 'velocityType'}¶
- property name¶
Gets the name of this VelocityResultControlItem. # noqa: E501
- Returns
The name of this VelocityResultControlItem. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'type': 'str', 'velocity_type': 'GlobalVelocityType'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this VelocityResultControlItem. # noqa: E501
Schema name: VelocityResultControlItem # noqa: E501
- Returns
The type of this VelocityResultControlItem. # noqa: E501
- Return type
str
- property velocity_type¶
Gets the velocity_type of this VelocityResultControlItem. # noqa: E501
- Returns
The velocity_type of this VelocityResultControlItem. # noqa: E501
- Return type
simscale_sdk.models.volume_heat_flux_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.volume_heat_flux_bc.VolumeHeatFluxBC(type='VOLUME_HEAT_FLUX', name=None, heatflux_value=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'heatflux_value': 'heatfluxValue', 'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property heatflux_value¶
Gets the heatflux_value of this VolumeHeatFluxBC. # noqa: E501
- Returns
The heatflux_value of this VolumeHeatFluxBC. # noqa: E501
- Return type
- property name¶
Gets the name of this VolumeHeatFluxBC. # noqa: E501
- Returns
The name of this VolumeHeatFluxBC. # noqa: E501
- Return type
str
- openapi_types = {'heatflux_value': 'DimensionalFunctionVolumetricPower', 'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this VolumeHeatFluxBC. # noqa: E501
- Returns
The topological_reference of this VolumeHeatFluxBC. # noqa: E501
- Return type
- property type¶
Gets the type of this VolumeHeatFluxBC. # noqa: E501
This is a <b>volume heat source</b> boundary condition. It is applied to the <b>volume elements</b> in the selected volumes or volume groups.<br /><br />Important remarks: <br /><ul><li>The total heat generated depends on the volume of the selection as the value is given as Watt per cubic meter.</li><li>For positive values heat is generated, for negative values the bc represents a heat sink.</li><li>You may define a <b>parameter dependent (x,y,z,t)</b> value by defining a formula or uploading a table (csv-file)</li></ul> Schema name: VolumeHeatFluxBC # noqa: E501
- Returns
The type of this VolumeHeatFluxBC. # noqa: E501
- Return type
str
simscale_sdk.models.volume_load_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.volume_load_bc.VolumeLoadBC(type='VOLUME_LOAD', name=None, load=None, scaling=None, phase_angle=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'load': 'load', 'name': 'name', 'phase_angle': 'phaseAngle', 'scaling': 'scaling', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property load¶
Gets the load of this VolumeLoadBC. # noqa: E501
- Returns
The load of this VolumeLoadBC. # noqa: E501
- Return type
- property name¶
Gets the name of this VolumeLoadBC. # noqa: E501
- Returns
The name of this VolumeLoadBC. # noqa: E501
- Return type
str
- openapi_types = {'load': 'DimensionalVectorFunctionVolumeForce', 'name': 'str', 'phase_angle': 'DimensionalAngle', 'scaling': 'DimensionalFunctionDimensionless', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- property phase_angle¶
Gets the phase_angle of this VolumeLoadBC. # noqa: E501
- Returns
The phase_angle of this VolumeLoadBC. # noqa: E501
- Return type
- property scaling¶
Gets the scaling of this VolumeLoadBC. # noqa: E501
- Returns
The scaling of this VolumeLoadBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this VolumeLoadBC. # noqa: E501
- Returns
The topological_reference of this VolumeLoadBC. # noqa: E501
- Return type
- property type¶
Gets the type of this VolumeLoadBC. # noqa: E501
This is a <b>volume load</b> boundary condition representing a distributed load on the selected volumes applied in the global coordinate system and each element of the assignment is loaded with a volume force depending on the volume of the element.<br /><br />Important remarks: <br /><ul><li>The applied total force depends on the volume of the selection.</li></ul><a href= https://www.simscale.com/docs/simulation-setup/boundary-conditions/volume-load/’ target=’_blank’>Learn more</a>. Schema name: VolumeLoadBC # noqa: E501
- Returns
The type of this VolumeLoadBC. # noqa: E501
- Return type
str
simscale_sdk.models.volumetric_flow module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.volumetric_flow.VolumetricFlow(type='VOLUMETRIC', value=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'value': 'value'}¶
- openapi_types = {'type': 'str', 'value': 'DimensionalFunctionVolumetricFlowRate'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this VolumetricFlow. # noqa: E501
<p>Defines the volumetric flow rate <strong>per each face</strong> of the assignment.</p> Schema name: VolumetricFlow # noqa: E501
- Returns
The type of this VolumetricFlow. # noqa: E501
- Return type
str
- property value¶
Gets the value of this VolumetricFlow. # noqa: E501
- Returns
The value of this VolumetricFlow. # noqa: E501
- Return type
simscale_sdk.models.von_mises_stress_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.von_mises_stress_type.VonMisesStressType(type='VON_MISES', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this VonMisesStressType. # noqa: E501
Schema name: VonMisesStressType # noqa: E501
- Returns
The type of this VonMisesStressType. # noqa: E501
- Return type
str
simscale_sdk.models.vorticity_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.vorticity_result_type.VorticityResultType(type='VORTICITY', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this VorticityResultType. # noqa: E501
Schema name: VorticityResultType # noqa: E501
- Returns
The type of this VorticityResultType. # noqa: E501
- Return type
str
simscale_sdk.models.wall_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_bc.WallBC(type='WALL_V34', name=None, velocity=None, temperature=None, phase_fraction=None, net_radiative_heat_flux=None, radiative_intensity_ray=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'net_radiative_heat_flux': 'netRadiativeHeatFlux', 'phase_fraction': 'phaseFraction', 'radiative_intensity_ray': 'radiativeIntensityRay', 'temperature': 'temperature', 'topological_reference': 'topologicalReference', 'type': 'type', 'velocity': 'velocity'}¶
- property name¶
Gets the name of this WallBC. # noqa: E501
- Returns
The name of this WallBC. # noqa: E501
- Return type
str
- property net_radiative_heat_flux¶
Gets the net_radiative_heat_flux of this WallBC. # noqa: E501
- Returns
The net_radiative_heat_flux of this WallBC. # noqa: E501
- Return type
OneOfWallBCNetRadiativeHeatFlux
- openapi_types = {'name': 'str', 'net_radiative_heat_flux': 'OneOfWallBCNetRadiativeHeatFlux', 'phase_fraction': 'OneOfWallBCPhaseFraction', 'radiative_intensity_ray': 'OneOfWallBCRadiativeIntensityRay', 'temperature': 'OneOfWallBCTemperature', 'topological_reference': 'TopologicalReference', 'type': 'str', 'velocity': 'OneOfWallBCVelocity'}¶
- property phase_fraction¶
Gets the phase_fraction of this WallBC. # noqa: E501
- Returns
The phase_fraction of this WallBC. # noqa: E501
- Return type
OneOfWallBCPhaseFraction
- property radiative_intensity_ray¶
Gets the radiative_intensity_ray of this WallBC. # noqa: E501
- Returns
The radiative_intensity_ray of this WallBC. # noqa: E501
- Return type
OneOfWallBCRadiativeIntensityRay
- property temperature¶
Gets the temperature of this WallBC. # noqa: E501
- Returns
The temperature of this WallBC. # noqa: E501
- Return type
OneOfWallBCTemperature
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this WallBC. # noqa: E501
- Returns
The topological_reference of this WallBC. # noqa: E501
- Return type
- property type¶
Gets the type of this WallBC. # noqa: E501
<p>This boundary provides several Solid Wall conditions.</P>The default <b>no-slip</b> corresponds to friction wall with no movement. The <b>slip wall</b> models a surface with no friction. The <b>rotating/moving wall</b> model wall movement by prescribing velocities. <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/wall/’ target=’_blank’>Learn more</a>. Schema name: WallBC # noqa: E501
- Returns
The type of this WallBC. # noqa: E501
- Return type
str
- property velocity¶
Gets the velocity of this WallBC. # noqa: E501
- Returns
The velocity of this WallBC. # noqa: E501
- Return type
OneOfWallBCVelocity
simscale_sdk.models.wall_function_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_dvbc.WallFunctionDVBC(type='WALL_FUNCTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionDVBC. # noqa: E501
Schema name: WallFunctionDVBC # noqa: E501
- Returns
The type of this WallFunctionDVBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_ebc.WallFunctionEBC(type='WALL_FUNCTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionEBC. # noqa: E501
Schema name: WallFunctionEBC # noqa: E501
- Returns
The type of this WallFunctionEBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_evbc.WallFunctionEVBC(type='WALL_FUNCTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionEVBC. # noqa: E501
Schema name: WallFunctionEVBC # noqa: E501
- Returns
The type of this WallFunctionEVBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_evcbc.WallFunctionEVCBC(type='WALL_FUNCTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionEVCBC. # noqa: E501
Schema name: WallFunctionEVCBC # noqa: E501
- Returns
The type of this WallFunctionEVCBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_nbc.WallFunctionNBC(type='WALL_FUNCTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionNBC. # noqa: E501
Schema name: WallFunctionNBC # noqa: E501
- Returns
The type of this WallFunctionNBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_obc.WallFunctionOBC(type='WALL_FUNCTION', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionOBC. # noqa: E501
Schema name: WallFunctionOBC # noqa: E501
- Returns
The type of this WallFunctionOBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_tdbc.WallFunctionTDBC(type='WALL_FUNCTION', prandtl_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'prandtl_number': 'prandtlNumber', 'type': 'type'}¶
- openapi_types = {'prandtl_number': 'float', 'type': 'str'}¶
- property prandtl_number¶
Gets the prandtl_number of this WallFunctionTDBC. # noqa: E501
- Returns
The prandtl_number of this WallFunctionTDBC. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionTDBC. # noqa: E501
Schema name: WallFunctionTDBC # noqa: E501
- Returns
The type of this WallFunctionTDBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_tdcbc.WallFunctionTDCBC(type='WALL_FUNCTION', prandtl_number=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'prandtl_number': 'prandtlNumber', 'type': 'type'}¶
- openapi_types = {'prandtl_number': 'float', 'type': 'str'}¶
- property prandtl_number¶
Gets the prandtl_number of this WallFunctionTDCBC. # noqa: E501
- Returns
The prandtl_number of this WallFunctionTDCBC. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionTDCBC. # noqa: E501
Schema name: WallFunctionTDCBC # noqa: E501
- Returns
The type of this WallFunctionTDCBC. # noqa: E501
- Return type
str
simscale_sdk.models.wall_function_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_function_tkebc.WallFunctionTKEBC(type='WALL_FUNCTION', wall_roughness=None, roughness_height=None, roughness_constant=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'roughness_constant': 'roughnessConstant', 'roughness_height': 'roughnessHeight', 'type': 'type', 'wall_roughness': 'wallRoughness'}¶
- openapi_types = {'roughness_constant': 'float', 'roughness_height': 'DimensionalLength', 'type': 'str', 'wall_roughness': 'bool'}¶
- property roughness_constant¶
Gets the roughness_constant of this WallFunctionTKEBC. # noqa: E501
- Returns
The roughness_constant of this WallFunctionTKEBC. # noqa: E501
- Return type
float
- property roughness_height¶
Gets the roughness_height of this WallFunctionTKEBC. # noqa: E501
- Returns
The roughness_height of this WallFunctionTKEBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallFunctionTKEBC. # noqa: E501
Schema name: WallFunctionTKEBC # noqa: E501
- Returns
The type of this WallFunctionTKEBC. # noqa: E501
- Return type
str
- property wall_roughness¶
Gets the wall_roughness of this WallFunctionTKEBC. # noqa: E501
- Returns
The wall_roughness of this WallFunctionTKEBC. # noqa: E501
- Return type
bool
simscale_sdk.models.wall_heat_transfer_tbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_heat_transfer_tbc.WallHeatTransferTBC(type='WALL_HEAT_TRANSFER', wall_temperature=None, thermal_diffusivity=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'thermal_diffusivity': 'thermalDiffusivity', 'type': 'type', 'wall_temperature': 'wallTemperature'}¶
- openapi_types = {'thermal_diffusivity': 'DimensionalKinematicViscosity', 'type': 'str', 'wall_temperature': 'DimensionalTemperature'}¶
- property thermal_diffusivity¶
Gets the thermal_diffusivity of this WallHeatTransferTBC. # noqa: E501
- Returns
The thermal_diffusivity of this WallHeatTransferTBC. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallHeatTransferTBC. # noqa: E501
Schema name: WallHeatTransferTBC # noqa: E501
- Returns
The type of this WallHeatTransferTBC. # noqa: E501
- Return type
str
- property wall_temperature¶
Gets the wall_temperature of this WallHeatTransferTBC. # noqa: E501
- Returns
The wall_temperature of this WallHeatTransferTBC. # noqa: E501
- Return type
simscale_sdk.models.wall_shear_stress_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wall_shear_stress_result_type.WallShearStressResultType(type='WALL_SHEAR_STRESS', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WallShearStressResultType. # noqa: E501
Schema name: WallShearStressResultType # noqa: E501
- Returns
The type of this WallShearStressResultType. # noqa: E501
- Return type
str
simscale_sdk.models.wave_transmissive_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wave_transmissive_pbc.WaveTransmissivePBC(type='WAVE_TRANSMISSIVE', specific_heat_ratio=None, relax_boundary=None, far_field_value=None, relaxation_length_scale=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'far_field_value': 'farFieldValue', 'relax_boundary': 'relaxBoundary', 'relaxation_length_scale': 'relaxationLengthScale', 'specific_heat_ratio': 'specificHeatRatio', 'type': 'type'}¶
- property far_field_value¶
Gets the far_field_value of this WaveTransmissivePBC. # noqa: E501
- Returns
The far_field_value of this WaveTransmissivePBC. # noqa: E501
- Return type
- openapi_types = {'far_field_value': 'DimensionalPressure', 'relax_boundary': 'bool', 'relaxation_length_scale': 'DimensionalLength', 'specific_heat_ratio': 'float', 'type': 'str'}¶
- property relax_boundary¶
Gets the relax_boundary of this WaveTransmissivePBC. # noqa: E501
- Returns
The relax_boundary of this WaveTransmissivePBC. # noqa: E501
- Return type
bool
- property relaxation_length_scale¶
Gets the relaxation_length_scale of this WaveTransmissivePBC. # noqa: E501
- Returns
The relaxation_length_scale of this WaveTransmissivePBC. # noqa: E501
- Return type
- property specific_heat_ratio¶
Gets the specific_heat_ratio of this WaveTransmissivePBC. # noqa: E501
- Returns
The specific_heat_ratio of this WaveTransmissivePBC. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WaveTransmissivePBC. # noqa: E501
Schema name: WaveTransmissivePBC # noqa: E501
- Returns
The type of this WaveTransmissivePBC. # noqa: E501
- Return type
str
simscale_sdk.models.wedge_bc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wedge_bc.WedgeBC(type='WEDGE', name=None, topological_reference=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'topological_reference': 'topologicalReference', 'type': 'type'}¶
- property name¶
Gets the name of this WedgeBC. # noqa: E501
- Returns
The name of this WedgeBC. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'topological_reference': 'TopologicalReference', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property topological_reference¶
Gets the topological_reference of this WedgeBC. # noqa: E501
- Returns
The topological_reference of this WedgeBC. # noqa: E501
- Return type
- property type¶
Gets the type of this WedgeBC. # noqa: E501
This boundary condition is applied to the front and back faces of an axisymmetric system (eg. cylinder). Note that the face elements of the mesh need to be congruent on both the faces. Works for uploaded 2D meshes only. <a href=’https://www.simscale.com/docs/simulation-setup/boundary-conditions/wedge/’ target=’_blank’>Learn more</a>. Schema name: WedgeBC # noqa: E501
- Returns
The type of this WedgeBC. # noqa: E501
- Return type
str
simscale_sdk.models.wind_comfort module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_comfort.WindComfort(type='WIND_COMFORT', region_of_interest=None, wind_conditions=None, pedestrian_comfort_map=None, simulation_control=None, advanced_modelling=None, additional_result_export=None, mesh_settings=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property additional_result_export¶
Gets the additional_result_export of this WindComfort. # noqa: E501
- Returns
The additional_result_export of this WindComfort. # noqa: E501
- Return type
- property advanced_modelling¶
Gets the advanced_modelling of this WindComfort. # noqa: E501
- Returns
The advanced_modelling of this WindComfort. # noqa: E501
- Return type
- attribute_map = {'additional_result_export': 'additionalResultExport', 'advanced_modelling': 'advancedModelling', 'mesh_settings': 'meshSettings', 'pedestrian_comfort_map': 'pedestrianComfortMap', 'region_of_interest': 'regionOfInterest', 'simulation_control': 'simulationControl', 'type': 'type', 'wind_conditions': 'windConditions'}¶
- property mesh_settings¶
Gets the mesh_settings of this WindComfort. # noqa: E501
- Returns
The mesh_settings of this WindComfort. # noqa: E501
- Return type
- openapi_types = {'additional_result_export': 'FluidResultControls', 'advanced_modelling': 'AdvancedModelling', 'mesh_settings': 'WindComfortMesh', 'pedestrian_comfort_map': 'list[PedestrianComfortSurface]', 'region_of_interest': 'RegionOfInterest', 'simulation_control': 'WindComfortSimulationControl', 'type': 'str', 'wind_conditions': 'WindConditions'}¶
- property pedestrian_comfort_map¶
Gets the pedestrian_comfort_map of this WindComfort. # noqa: E501
- Returns
The pedestrian_comfort_map of this WindComfort. # noqa: E501
- Return type
list[PedestrianComfortSurface]
- property region_of_interest¶
Gets the region_of_interest of this WindComfort. # noqa: E501
- Returns
The region_of_interest of this WindComfort. # noqa: E501
- Return type
- property simulation_control¶
Gets the simulation_control of this WindComfort. # noqa: E501
- Returns
The simulation_control of this WindComfort. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WindComfort. # noqa: E501
Schema name: WindComfort # noqa: E501
- Returns
The type of this WindComfort. # noqa: E501
- Return type
str
- property wind_conditions¶
Gets the wind_conditions of this WindComfort. # noqa: E501
- Returns
The wind_conditions of this WindComfort. # noqa: E501
- Return type
simscale_sdk.models.wind_comfort_mesh module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_comfort_mesh.WindComfortMesh(wind_comfort_fineness=None, refinements=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'refinements': 'refinements', 'wind_comfort_fineness': 'windComfortFineness'}¶
- openapi_types = {'refinements': 'list[OneOfWindComfortMeshRefinements]', 'wind_comfort_fineness': 'OneOfWindComfortMeshWindComfortFineness'}¶
- property refinements¶
Gets the refinements of this WindComfortMesh. # noqa: E501
- Returns
The refinements of this WindComfortMesh. # noqa: E501
- Return type
list[OneOfWindComfortMeshRefinements]
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property wind_comfort_fineness¶
Gets the wind_comfort_fineness of this WindComfortMesh. # noqa: E501
- Returns
The wind_comfort_fineness of this WindComfortMesh. # noqa: E501
- Return type
OneOfWindComfortMeshWindComfortFineness
simscale_sdk.models.wind_comfort_simulation_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_comfort_simulation_control.WindComfortSimulationControl(max_direction_run_time=None, number_of_fluid_passes=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'max_direction_run_time': 'maxDirectionRunTime', 'number_of_fluid_passes': 'numberOfFluidPasses'}¶
- property max_direction_run_time¶
Gets the max_direction_run_time of this WindComfortSimulationControl. # noqa: E501
- Returns
The max_direction_run_time of this WindComfortSimulationControl. # noqa: E501
- Return type
- property number_of_fluid_passes¶
Gets the number_of_fluid_passes of this WindComfortSimulationControl. # noqa: E501
<p>Set how many times the fluid (air) passes over the domain during the simulation.</p><p> <b>Warning</b>: Values below 2.0 might produce invalid results while higher numbers will require more simulation time and consequently more GPU hours. Recommended value is 3.0. <a href=’https://www.simscale.com/docs/analysis-types/pedestrian-wind-comfort-analysis/simulation-control/’ target=’_blank’>Learn more</a>.</p> # noqa: E501
- Returns
The number_of_fluid_passes of this WindComfortSimulationControl. # noqa: E501
- Return type
float
- openapi_types = {'max_direction_run_time': 'DimensionalTime', 'number_of_fluid_passes': 'float'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.wind_conditions module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_conditions.WindConditions(geographical_location=None, wind_rose=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'geographical_location': 'geographicalLocation', 'wind_rose': 'windRose'}¶
- property geographical_location¶
Gets the geographical_location of this WindConditions. # noqa: E501
- Returns
The geographical_location of this WindConditions. # noqa: E501
- Return type
- openapi_types = {'geographical_location': 'GeographicalLocation', 'wind_rose': 'WindRose'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.wind_data module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_data.WindData(name=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name'}¶
- property name¶
Gets the name of this WindData. # noqa: E501
The name of the newly created simulation run. # noqa: E501
- Returns
The name of this WindData. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.wind_rose module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_rose.WindRose(num_directions=None, velocity_buckets=None, velocity_unit='m/s', exposure_categories=None, wind_engineering_standard=None, wind_data_source=None, add_surface_roughness=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- property add_surface_roughness¶
Gets the add_surface_roughness of this WindRose. # noqa: E501
- Returns
The add_surface_roughness of this WindRose. # noqa: E501
- Return type
bool
- attribute_map = {'add_surface_roughness': 'addSurfaceRoughness', 'exposure_categories': 'exposureCategories', 'num_directions': 'numDirections', 'velocity_buckets': 'velocityBuckets', 'velocity_unit': 'velocityUnit', 'wind_data_source': 'windDataSource', 'wind_engineering_standard': 'windEngineeringStandard'}¶
- property exposure_categories¶
Gets the exposure_categories of this WindRose. # noqa: E501
- Returns
The exposure_categories of this WindRose. # noqa: E501
- Return type
list[str]
- property num_directions¶
Gets the num_directions of this WindRose. # noqa: E501
- Returns
The num_directions of this WindRose. # noqa: E501
- Return type
int
- openapi_types = {'add_surface_roughness': 'bool', 'exposure_categories': 'list[str]', 'num_directions': 'int', 'velocity_buckets': 'list[WindRoseVelocityBucket]', 'velocity_unit': 'str', 'wind_data_source': 'str', 'wind_engineering_standard': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property velocity_buckets¶
Gets the velocity_buckets of this WindRose. # noqa: E501
- Returns
The velocity_buckets of this WindRose. # noqa: E501
- Return type
list[WindRoseVelocityBucket]
- property velocity_unit¶
Gets the velocity_unit of this WindRose. # noqa: E501
- Returns
The velocity_unit of this WindRose. # noqa: E501
- Return type
str
- property wind_data_source¶
Gets the wind_data_source of this WindRose. # noqa: E501
- Returns
The wind_data_source of this WindRose. # noqa: E501
- Return type
str
- property wind_engineering_standard¶
Gets the wind_engineering_standard of this WindRose. # noqa: E501
- Returns
The wind_engineering_standard of this WindRose. # noqa: E501
- Return type
str
simscale_sdk.models.wind_rose_velocity_bucket module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_rose_velocity_bucket.WindRoseVelocityBucket(_from=None, to=None, fractions=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'_from': 'from', 'fractions': 'fractions', 'to': 'to'}¶
- property fractions¶
Gets the fractions of this WindRoseVelocityBucket. # noqa: E501
- Returns
The fractions of this WindRoseVelocityBucket. # noqa: E501
- Return type
list[float]
- openapi_types = {'_from': 'float', 'fractions': 'list[float]', 'to': 'float'}¶
- property to¶
Gets the to of this WindRoseVelocityBucket. # noqa: E501
- Returns
The to of this WindRoseVelocityBucket. # noqa: E501
- Return type
float
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
simscale_sdk.models.wind_tunnel_size_custom module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_tunnel_size_custom.WindTunnelSizeCustom(type='WIND_TUNNEL_SIZE_CUSTOM', height_extension=None, side_extension=None, inflow_extension=None, outflow_extension=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'height_extension': 'heightExtension', 'inflow_extension': 'inflowExtension', 'outflow_extension': 'outflowExtension', 'side_extension': 'sideExtension', 'type': 'type'}¶
- property height_extension¶
Gets the height_extension of this WindTunnelSizeCustom. # noqa: E501
- Returns
The height_extension of this WindTunnelSizeCustom. # noqa: E501
- Return type
- property inflow_extension¶
Gets the inflow_extension of this WindTunnelSizeCustom. # noqa: E501
- Returns
The inflow_extension of this WindTunnelSizeCustom. # noqa: E501
- Return type
- openapi_types = {'height_extension': 'DimensionalLength', 'inflow_extension': 'DimensionalLength', 'outflow_extension': 'DimensionalLength', 'side_extension': 'DimensionalLength', 'type': 'str'}¶
- property outflow_extension¶
Gets the outflow_extension of this WindTunnelSizeCustom. # noqa: E501
- Returns
The outflow_extension of this WindTunnelSizeCustom. # noqa: E501
- Return type
- property side_extension¶
Gets the side_extension of this WindTunnelSizeCustom. # noqa: E501
- Returns
The side_extension of this WindTunnelSizeCustom. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WindTunnelSizeCustom. # noqa: E501
Schema name: WindTunnelSizeCustom # noqa: E501
- Returns
The type of this WindTunnelSizeCustom. # noqa: E501
- Return type
str
simscale_sdk.models.wind_tunnel_size_large module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_tunnel_size_large.WindTunnelSizeLarge(type='WIND_TUNNEL_SIZE_LARGE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WindTunnelSizeLarge. # noqa: E501
Schema name: WindTunnelSizeLarge # noqa: E501
- Returns
The type of this WindTunnelSizeLarge. # noqa: E501
- Return type
str
simscale_sdk.models.wind_tunnel_size_moderate module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.wind_tunnel_size_moderate.WindTunnelSizeModerate(type='WIND_TUNNEL_SIZE_MODERATE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WindTunnelSizeModerate. # noqa: E501
Schema name: WindTunnelSizeModerate # noqa: E501
- Returns
The type of this WindTunnelSizeModerate. # noqa: E501
- Return type
str
simscale_sdk.models.with_cell_zone module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.with_cell_zone.WithCellZone(type='WITH_CELL_ZONE_V11', name=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'type': 'type'}¶
- property name¶
Gets the name of this WithCellZone. # noqa: E501
- Returns
The name of this WithCellZone. # noqa: E501
- Return type
str
- openapi_types = {'name': 'str', 'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WithCellZone. # noqa: E501
Schema name: WithCellZone # noqa: E501
- Returns
The type of this WithCellZone. # noqa: E501
- Return type
str
simscale_sdk.models.with_fictitious_clearance module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.with_fictitious_clearance.WithFictitiousClearance(type='WITH_FICTITIOUS_CLEARANCE', master_clearance=None, slave_clearance=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'master_clearance': 'masterClearance', 'slave_clearance': 'slaveClearance', 'type': 'type'}¶
- property master_clearance¶
Gets the master_clearance of this WithFictitiousClearance. # noqa: E501
- Returns
The master_clearance of this WithFictitiousClearance. # noqa: E501
- Return type
- openapi_types = {'master_clearance': 'DimensionalFunctionLength', 'slave_clearance': 'DimensionalFunctionLength', 'type': 'str'}¶
- property slave_clearance¶
Gets the slave_clearance of this WithFictitiousClearance. # noqa: E501
- Returns
The slave_clearance of this WithFictitiousClearance. # noqa: E501
- Return type
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WithFictitiousClearance. # noqa: E501
Schema name: WithFictitiousClearance # noqa: E501
- Returns
The type of this WithFictitiousClearance. # noqa: E501
- Return type
str
simscale_sdk.models.without_cell_zone module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.without_cell_zone.WithoutCellZone(type='WITHOUT_CELL_ZONE', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WithoutCellZone. # noqa: E501
Schema name: WithoutCellZone # noqa: E501
- Returns
The type of this WithoutCellZone. # noqa: E501
- Return type
str
simscale_sdk.models.write_interval_write_control module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.write_interval_write_control.WriteIntervalWriteControl(type='WRITE_INTERVAL', write_interval=None, local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type', 'write_interval': 'writeInterval'}¶
- openapi_types = {'type': 'str', 'write_interval': 'int'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this WriteIntervalWriteControl. # noqa: E501
<p>Define how frequently intermediate results should be saved. With the selection of <b>initial time steps</b> only the user defined time steps are stored in the result and by selecting <b>all computed time steps</b> also intermediate results that were created by the automatic time stepping are saved. With the selection of <b>write interval</b> a specific write frequency can be chosen which reduces the result size. Finally using <b>user defined time steps</b> there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the <b>time step length</b> definition.</p> Schema name: WriteIntervalWriteControl # noqa: E501
- Returns
The type of this WriteIntervalWriteControl. # noqa: E501
- Return type
str
- property write_interval¶
Gets the write_interval of this WriteIntervalWriteControl. # noqa: E501
<p>Define the write frequency of the intermediate results to the result file. Selecting a write interval of 2 means that every second computed time step is saved in the final result database, independently if it is a pre-defined user time step or an intermediate one that was added during automatic time stepping. </p> # noqa: E501
- Returns
The write_interval of this WriteIntervalWriteControl. # noqa: E501
- Return type
int
simscale_sdk.models.y_plus_ras_result_type module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.y_plus_ras_result_type.YPlusRASResultType(type='DIMENSIONLESS_WALL_DISTANCE_YPLUS', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this YPlusRASResultType. # noqa: E501
Schema name: YPlusRASResultType # noqa: E501
- Returns
The type of this YPlusRASResultType. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_dvbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_dvbc.ZeroGradientDVBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientDVBC. # noqa: E501
Schema name: ZeroGradientDVBC # noqa: E501
- Returns
The type of this ZeroGradientDVBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_ebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_ebc.ZeroGradientEBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientEBC. # noqa: E501
Schema name: ZeroGradientEBC # noqa: E501
- Returns
The type of this ZeroGradientEBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_evbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_evbc.ZeroGradientEVBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientEVBC. # noqa: E501
Schema name: ZeroGradientEVBC # noqa: E501
- Returns
The type of this ZeroGradientEVBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_evcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_evcbc.ZeroGradientEVCBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientEVCBC. # noqa: E501
Schema name: ZeroGradientEVCBC # noqa: E501
- Returns
The type of this ZeroGradientEVCBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_nbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_nbc.ZeroGradientNBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientNBC. # noqa: E501
Schema name: ZeroGradientNBC # noqa: E501
- Returns
The type of this ZeroGradientNBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_obc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_obc.ZeroGradientOBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientOBC. # noqa: E501
Schema name: ZeroGradientOBC # noqa: E501
- Returns
The type of this ZeroGradientOBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_pbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_pbc.ZeroGradientPBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientPBC. # noqa: E501
Schema name: ZeroGradientPBC # noqa: E501
- Returns
The type of this ZeroGradientPBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_pfbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_pfbc.ZeroGradientPFBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientPFBC. # noqa: E501
Schema name: ZeroGradientPFBC # noqa: E501
- Returns
The type of this ZeroGradientPFBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_psbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_psbc.ZeroGradientPSBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientPSBC. # noqa: E501
Schema name: ZeroGradientPSBC # noqa: E501
- Returns
The type of this ZeroGradientPSBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_tdbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_tdbc.ZeroGradientTDBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientTDBC. # noqa: E501
Schema name: ZeroGradientTDBC # noqa: E501
- Returns
The type of this ZeroGradientTDBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_tdcbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_tdcbc.ZeroGradientTDCBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientTDCBC. # noqa: E501
Schema name: ZeroGradientTDCBC # noqa: E501
- Returns
The type of this ZeroGradientTDCBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_tkebc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_tkebc.ZeroGradientTKEBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientTKEBC. # noqa: E501
Schema name: ZeroGradientTKEBC # noqa: E501
- Returns
The type of this ZeroGradientTKEBC. # noqa: E501
- Return type
str
simscale_sdk.models.zero_gradient_vbc module¶
SimScale API
The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech
- class simscale_sdk.models.zero_gradient_vbc.ZeroGradientVBC(type='ZERO_GRADIENT', local_vars_configuration=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type': 'type'}¶
- openapi_types = {'type': 'str'}¶
- to_dict()¶
Returns the model properties as a dict
- to_str()¶
Returns the string representation of the model
- property type¶
Gets the type of this ZeroGradientVBC. # noqa: E501
Schema name: ZeroGradientVBC # noqa: E501
- Returns
The type of this ZeroGradientVBC. # noqa: E501
- Return type
str